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

外部コレクションのリフレッシュジョブを一覧表示 (V2)

この操作は、外部コレクションのリフレッシュジョブを一覧表示します。collectionName が省略されているか空の場合、対象データベース内のすべての外部コレクションにわたるリフレッシュジョブを返します。

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

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

外部コレクションの名前。空のままにするか省略すると、データベース内のすべての外部コレクションのリフレッシュジョブを一覧表示します。

bash
export TOKEN="YOUR_API_KEY"

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

リフレッシュジョブの一覧を返します。

codeinteger

レスポンスコード。

値の例： 0
dataobject

リフレッシュジョブの一覧をラップするレスポンスペイロード。

recordsarray

リフレッシュジョブの詳細一覧。

[]recordsobject

リフレッシュジョブの詳細。

jobIdinteger<int64>

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

collectionNamestring

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

statestring

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

progressinteger

パーセンテージ（0-100）で表したリフレッシュの進行状況。

externalSourcestring

このジョブがリフレッシュ元としているソース設定を JSON エンコードしたもの。Zilliz Cloud volume 内の object url が適用されます。

startTimeinteger<int64>

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

endTimeinteger<int64>

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

reasonstring

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

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "records": [
            {
                "jobId": 449503829274509300,
                "collectionName": "ext_books",
                "state": "RefreshCompleted",
                "progress": 100,
                "externalSource": "{\"type\":\"volume\",\"path\":\"volume://my-volume/books\"}",
                "startTime": 1712832000000,
                "endTime": 1712832600000
            },
            {
                "jobId": 449503829274509300,
                "collectionName": "ext_movies",
                "state": "RefreshInProgress",
                "progress": 42,
                "externalSource": "{\"type\":\"volume\",\"path\":\"volume://my-volume/movies\"}",
                "startTime": 1712833000000,
                "endTime": 0
            }
        ]
    }
}
Ctrl I