メインコンテンツまでスキップ

API Key を更新 (V2)

カスタマイズされた ACL API key を更新します。ロールの割り当てには完全置換セマンティクスが使用されます。

PUT/v2/api-keys/{apiKeyId}
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つ API key である必要があります。

値の例： Bearer {{TOKEN}}
apiKeyIdstringpath必要

公開 API key の ID。

値の例： key-xxxxxxxxxxxxxx
リクエスト・ボディapplication/json
namestring必要

API key の表示名。空白にすることはできません。

descriptionstring

API key の説明。

orgRolestring必要

API key に割り当てられた組織ロール: Owner、Member、または Billing-Admin。

projectsarray

プロジェクトレベルのアクセスリスト。orgRole が Member の場合に必須です。

[]projectsobject
projectIdstring必要

プロジェクト ID。

rolestring必要

プロジェクトロール: Admin、Read-Write、または Read-Only。

allClusterboolean

アクセスがプロジェクト内のすべてのクラスターを対象とするかどうか。

clusterIdsarray

allCluster が false の場合に API key がアクセスできるクラスター。

[]clusterIdsstring
(近日追加予定)
allVolumeboolean

アクセスがプロジェクト内のすべてのボリュームを対象とするかどうか。

volumeIdsarray

allVolume が false の場合に API key がアクセスできるボリューム。

[]volumeIdsstring
(近日追加予定)
Replace The Complete Role Setbash
export TOKEN="YOUR_API_KEY"
export apiKeyId="key-xxxxxxxxxxxxxx"

curl --request PUT \
--url "${BASE_URL}/v2/api-keys/${apiKeyId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "name": "Data Pipeline Production",
    "description": "Production ingestion pipeline",
    "orgRole": "Member",
    "projects": [
        {
            "projectId": "proj-xxxxxxxx",
            "role": "Data Reader",
            "allCluster": true,
            "allVolume": true
        }
    ]
}'
レスポンス200 OK - application/json

成功した結果またはエラーメッセージを返します。

成功したレスポンス。

codeinteger必要

レスポンスコード。

値の例： 0
dataobject必要
apiKeyIdstring必要

公開 API key の ID。

namestring必要

API key の表示名。

descriptionstring

API key の説明。

creatorNamestring必要

作成者の解決済み表示名。

createdBystring必要

作成者のメールアドレス、または作成者 API key の ID。

orgRolestring必要

API key に割り当てられた組織ロール: Owner、Member、または Billing-Admin。

projectsarray必要

API key に付与されたプロジェクトレベルのアクセス。

[]projectsobject必要
projectIdstring必要

プロジェクト ID。

projectNamestring

プロジェクトの表示名。

rolestring必要

プロジェクトロール: Admin、Read-Write、または Read-Only。

allClusterboolean

アクセスがプロジェクト内のすべてのクラスターを対象とするかどうか。

clustersarray

API key がアクセスできるクラスター。

[]clustersobject
clusterIdstring必要

クラスター ID。

clusterNamestring必要

クラスターの表示名。

allVolumeboolean

アクセスがプロジェクト内のすべてのボリュームを対象とするかどうか。

volumesarray

API key がアクセスできるボリューム。

[]volumesobject
volumeIdstring必要

ボリューム ID。

volumeNamestring必要

ボリュームの表示名。

createTimestring<date-time>必要

UTC ISO 8601 形式の作成時刻。

失敗したレスポンス。

codeinteger必要

レスポンスコード。

messagestring必要

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "apiKeyId": "key-xxxxxxxxxxxxxx",
        "name": "Data Pipeline Production",
        "description": "Production ingestion pipeline",
        "creatorName": "Alice",
        "createdBy": "alice@example.com",
        "createTime": "2026-07-22T02:30:00Z",
        "orgRole": "Member",
        "projects": [
            {
                "projectId": "proj-xxxxxxxx",
                "projectName": "Project xxxx",
                "role": "Data Reader",
                "allCluster": true,
                "clusters": [],
                "allVolume": true,
                "volumes": []
            }
        ]
    }
}
Ctrl I