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

外部コレクションを更新 (V2)

この操作は、既存の外部コレクションに対して非同期のデータ更新ジョブを開始し、基盤となる外部ソースからコレクションのデータを再同期します。externalSource と externalSpec は両方を指定するか、両方を省略する必要があります。両方を省略した場合は、コレクションに以前保存された source と spec が再利用されます。

POST/v2/vectordb/jobs/external_collection/refresh
接続エンドポイント

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

shell
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つ API key または username:password のようにコロンで連結した username と password の組み合わせである必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。

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

データベースの名前。

collectionNamestring必要

更新するコレクションの名前。

externalSourcestring

外部データソースの JSON エンコードされた仕様。指定する場合は、externalSpec も指定する必要があります。省略した場合は、コレクションに保存されている source が再利用されます。Zilliz Cloud volume 内の object url を指定します。
このパラメータは Iceberg tables にのみ適用されます。

externalSpecstring

外部データがコレクションにどのようにマッピングされるかを記述する、JSON エンコードされた仕様。指定する場合は、externalSource も指定する必要があります。省略した場合は、コレクションに保存されている spec が再利用されます。
このパラメータは Iceberg tables にのみ適用されます。

Refresh From A Zilliz Cloud Volumebash
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/jobs/external_collection/refresh" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "default",
    "collectionName": "ext_books"
}'
レスポンス200 OK - application/json

新しく作成された更新ジョブの ID を返します。

codeinteger

レスポンスコード。

値の例： 0
dataobject

新しい更新ジョブの識別子を含むレスポンスペイロード。

jobIdinteger<int64>

新しく作成された更新ジョブの ID。この値を使用して describe endpoint から進行状況を照会します。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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