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

コレクションの名前変更 (V2)

この操作は、既存のコレクションに移動します。

POST/v2/vectordb/collections/rename
接続エンドポイント

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

コレクションが属するデータベースの名前。存在しないデータベースを指定するとエラーになります。指定しない場合は、デフォルトデータベースが適用されます。

collectionNamestring必要

対象コレクションの名前。 存在しないコレクションを指定するとエラーになります。

newDbNamestring

この操作後にコレクションが属するデータベースの名前。 値のデフォルトは default です。この操作前にコレクションが属していたデータベースとは異なるデータベースを指定すると、このコレクションは指定されたデータベースに移動されます。 存在しないデータベースを指定するとエラーになります。

newCollectionNamestring必要

この操作後の対象コレクションの名前。 元の名前を指定するとエラーになります。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/rename" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection",
    "newCollectionName": "quick_setup"
}'
レスポンス200 OK - application/json

なし

codeinteger

応答コード。

dataobject

エラーメッセージを返します。

codeinteger

応答コード。

messagestring

エラーメッセージ。

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