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

外部コレクションのリフレッシュジョブを記述します (V2)

この操作は、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 key または username:password のようにコロンで連結した username と password の組み合わせである必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。

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

記述するリフレッシュジョブの ID。リフレッシュ endpoint のレスポンスからこの値を取得します。

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 volume 内の object url が使用されます。

startTimeinteger<int64>

リフレッシュジョブが開始された時点の Unix timestamp。

endTimeinteger<int64>

リフレッシュジョブが終了した時点の Unix timestamp。ジョブがまだ実行中の場合は 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