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

Describe Alias (V2)

この操作は、特定のエイリアスの詳細を説明します。

POST/v2/vectordb/aliases/describe
接続エンドポイント

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

📘ノート
  • サービングクラスターを使用している場合は、クラスターエンドポイントを使用してください。

    • Free & Serverless

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated

      https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

  • ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
  • エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
shell
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つAPIキー、またはコロンで連結したユーザー名とパスワードのペア（例:username:password）である必要があります。プロジェクトエンドポイントを使用する場合は、十分な権限を持つ有効なAPIキーのみが適用されます。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
dbNamestring

エイリアスが属するデータベースの名前。

aliasNamestring必要

詳細が一覧表示されるエイリアスの名前。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "aliasName": "alice"
}'
レスポンス200 OK - application/json

エイリアスの詳細な説明を含むエイリアスオブジェクト。

codeinteger

応答コード。

値の例： 0
dataobject

エイリアスの詳細な説明を含む応答ペイロード。

dbNamestring

コレクションが属するデータベースの名前。

collectionNamestring

エイリアスが属するコレクションの名前。

aliasNamestring

エイリアスの名前。

エラーメッセージ。

codeinteger

応答コード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "aliasName": "alice",
        "collectionName": "quick_setup",
        "dbName": "default"
    }
}
Ctrl I