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

エイリアスの削除(V2)

この操作は、指定したエイリアスを削除します。

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

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}}
リクエスト・ボディ
dbNamestring

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

aliasNamestring必要

削除するエイリアス。 エイリアスを削除する際、1 つのエイリアスは 1 つのコレクションにのみ割り当てられるため、コレクション名を指定する必要はありません。したがって、サーバーは指定されたエイリアスがどのコレクションに属するかを認識します。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

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

空のオブジェクトまたはエラーメッセージを返します。

成功レスポンス

codeinteger

レスポンスコード。

値の例: 0
dataobject

空のオブジェクトであるレスポンスペイロード。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
"code": 0,
"data": {}
}
Ctrl I