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

インポートの進行状況を取得 (V1)

ノート

指定したインポートタスクの進行状況を取得します。

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

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 key を使用する必要があります。

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

対象のインポートタスクの ID

値の例： job-xxxxxxxxxxxxxxxxxx
clusterIdstringquery必要

この操作が適用されるクラスターの ID。

値の例： inxx-xxxxxxxxxxxxxxx
bash
export TOKEN="YOUR_API_KEY"

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

指定したジョブ ID の進行状況をパーセンテージで返します。

codeinteger

レスポンスコード。

dataobject

インポートタスクの進行状況を含むオブジェクトであるレスポンスペイロード。

fileNamestring

オブジェクトストレージ内のデータファイルオブジェクトのパス。

fileSizeinteger<int64>

データファイルオブジェクトのサイズ。

readyPercentagenumber<float>

インポートの進行状況を示す指標

completeTimestring

インポートタスクが完了した時刻。null は、ファイルのインポートが進行中であることを示します。

errorMessagestring

インポート失敗の理由を説明するメッセージ。null は、エラーが発生していないことを示します。

collectionNamestring

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

jobIdstring

インポートタスクの ID。

detailsarray

インポートタスクの詳細

[]detailsobject

データファイルごとのインポート進行状況の詳細一覧

fileNamestring

インポート中のファイルへのパス。

fileSizeinteger<int64>

インポート中のファイルのサイズ。

readyPercentagenumber<float>

特定のファイルのインポート進行状況。

completeTimestring

特定のファイルのインポート進行が終了した時刻。null は、ファイルのインポートが進行中であることを示します。

errorMessagestring

インポート失敗の理由を説明するメッセージ。null は、エラーが発生していないことを示します。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 200,
    "data": {
        "collectionName": "medium_articles",
        "fileName": "1af78216-xxxx-xxxx-xxxx-2b0a73c566ed/1.parquet",
        "fileSize": 19599887,
        "readyPercentage": 0,
        "completeTime": null,
        "errorMessage": null,
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx",
        "details": [
            {
                "fileName": "1af78216-xxxx-xxxx-xxxx-2b0a73c566ed/1.parquet",
                "fileSize": 19599887,
                "readyPercentage": 0,
                "completeTime": null,
                "errorMessage": null
            }
        ]
    }
}
Ctrl I