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

API Key を作成します (V2)

カスタマイズされた ACL API key を作成し、完全な初期ロールセットを割り当てます。シークレットは一度だけ返されます。

POST/v2/api-keys
接続エンドポイント

https://api.cloud.zilliz.com

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

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

値の例： Bearer {{TOKEN}}
リクエスト・ボディ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
(近日追加予定)
Create An API Keybash
export TOKEN="YOUR_API_KEY"

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

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

成功したレスポンス。

codeinteger必要

レスポンスコード。

値の例： 0
dataobject必要

新しく作成された API key の ID と、その一度限りのシークレット。

apiKeyIdstring必要

公開 API key の ID。

apiKeystring必要

シークレットの資格情報。この値は一度だけ返されます。

失敗したレスポンス。

codeinteger必要

レスポンスコード。

messagestring必要

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "apiKeyId": "key-xxxxxxxxxxxxxx",
        "apiKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
}
Ctrl I