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

List Import Jobs (V1)

ノート

特定のクラスターのすべてのインポートジョブを一覧表示します。

GET/v1/vector/collections/import/list
接続エンドポイント

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘ノート
shell
export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つAPIキーである必要があります。

値の例： Bearer {{TOKEN}}
clusterIdstringquery必要

Zilliz Cloud上の特定のクラスターのID。

値の例： inxx-xxxxxxxxxxxxxxx
pageSizestringquery

各リクエストで返されるレコード数。

値の例： 10
currentPagestringquery

現在のページ番号。

値の例： 1
bash
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/vector/collections/import/list?clusterId=inxx-xxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

インポートジョブの一覧を返します。

codestring

レスポンスコード。

dataobject

インポートジョブの詳細を含む一覧であるレスポンスペイロード。

countstring

このレスポンスに一覧表示されているレコードの総数。

currentPagestring

現在のページ番号（参考用）。

pageSizestring

各レスポンスに含まれるレコードの最大数。

tasksarray

インポートジョブの詳細を含む一覧。

[]tasksobject

インポートジョブの詳細。

collectionNamestring

インポートタスクの対象コレクション名。

jobIdstring

インポートタスクのID。

statestring

インポートタスクのステータス。指定可能な値は、ImportRunning、ImportCompleted、ImportFailedです。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 200,
    "data": {
        "tasks": [
            {
                "collectionName": "medium_articles",
                "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx",
                "state": "ImportRunning"
            },
            {
                "collectionName": "medium_articles",
                "jobId": "2b93fef7-xxxx-xxxx-xxxx-f82afd598ff1",
                "state": "ImportCompleted"
            }
        ],
        "count": 2,
        "currentPage": 1,
        "pageSize": 10
    }
}
Ctrl I