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

外部コレクションのリフレッシュジョブの説明（V2）

This operation returns the current state and progress of a single external-collection refresh job, identified by jobId.

POST/v2/vectordb/jobs/external_collection/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

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

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

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
jobIdinteger<int64>必要

説明対象のリフレッシュジョブのID。この値は、リフレッシュエンドポイントのレスポンスから取得してください。

bash
export TOKEN="YOUR_API_KEY"

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

指定されたリフレッシュジョブの状態と進行状況を返します。

codeinteger

レスポンスコード。

値の例： 0
dataobject

リフレッシュジョブの詳細を含むレスポンスペイロード。

jobIdinteger<int64>

リフレッシュジョブのID。

collectionNamestring

このリフレッシュジョブに関連付けられた外部コレクションの名前。

statestring

リフレッシュジョブの現在の状態。

progressinteger

リフレッシュの進捗状況（パーセント、0-100）。

externalSourcestring

このジョブのリフレッシュ元となるJSONエンコードされたソース設定。 Zilliz Cloud ボリューム内のオブジェクトURLが該当します。

startTimeinteger<int64>

リフレッシュジョブが開始されたUnixタイムスタンプ。

endTimeinteger<int64>

リフレッシュジョブが終了したUnixタイムスタンプ。ジョブがまだ実行中の場合は、0 です。

reasonstring

失敗理由。state が RefreshFailed の場合にのみ存在します。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "jobId": 449503829274509300,
        "collectionName": "ext_books",
        "state": "RefreshInProgress",
        "progress": 42,
        "externalSource": "{\"type\":\"volume\",\"path\":\"volume://my-volume/books\"}",
        "startTime": 1712832000000,
        "endTime": 0
    }
}
Ctrl I