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

コレクションフィールドの削除 (V2)

This operation drops a field from an existing collection by field name or field ID.

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

https://${CLUSTER_ENDPOINT}

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

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

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

データベースの名前。

collectionNamestring必要

コレクションの名前。

fieldNamestring

削除するフィールドの名前。

fieldIdinteger<int64>

削除するフィールドのID。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/fields/drop" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "default",
    "collectionName": "documents",
    "fieldName": "obsolete_field"
}'
レスポンス200 OK - application/json

空のオブジェクトを返します。

codeinteger

応答コード。

dataobject

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

codeinteger

応答コード。

messagestring

エラーメッセージ。

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