查看导入任务进度

Retrieves the progress of a specified import job.

POST

/v2/vectordb/jobs/import/getProgress

Base URL

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com.cn

export BASE_URL="https://api.cloud.zilliz.com.cn"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥。

示例值：Bearer {{TOKEN}}

Acceptstringheader

使用 application/json。

示例值：application/json

请求体application/json

jobIdstring必填项

指定导入任务 ID。

clusterIdstring必填项

指定集群 ID。

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/vectordb/jobs/import/getProgress" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "clusterId": "inxx-xxxxxxxxxxxxxxx",
    "jobId": "job-xxxxxxxxxxxxxxxxxxxxx"
}'

响应200 - application/json

SUCCESS

codestring

响应码。

dataobject

响应负载。

jobIdstring

导入任务 ID。

collectionNamestring

导入任务的目标 Collection 名称。

fileNamestring

对象存储中存放的数据文件对象的路径。

fileSizeinteger

数据文件对象的大小。

statestring

当前导入任务的状态。

枚举值：

progressinteger

当前导入任务的进度百分比。

completeTimestring

当前导入任务的完成时间。

reasonstring

当前导入任务失败的原因。任务成功时为空字符串。

totalRowsinteger

当前导入任务在目标 Collection 中插入的 Entity 数量。

detailsarray

按数据文件维度分别收集的数据导入统计信息。

[]detailsobject

Detailed information about the processing of a source data file.

fileNamestring

数据文件名称。

fileSizeinteger

数据文件大小。

statestring

数据文件处理状态。

枚举值：

progressinteger

数据文件处理进度。

completeTimestring

数据文件完成处理时间。

reasonstring

数据文件导入失败原因。当数据文件成功处理时，该值为空。

totalRowsinteger

当前文件在目标 Collection 中插入的 Entity 数量。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxx",
        "collectionName": "medium_articles",
        "fileName": "medium_articles_2020_dpr.json",
        "fileSize": 3279917,
        "state": "Completed",
        "progress": 100,
        "completeTime": "2024-04-01T06:17:55Z",
        "reason": "",
        "totalRows": 100000,
        "details": [
            {
                "fileName": "medium_articles_2020_dpr.json",
                "fileSize": 3279917,
                "state": "Completed",
                "progress": 100,
                "completeTime": "2024-04-01T06:17:53Z",
                "reason": ""
            }
        ]
    }
}