查看导入进度

Retrieves the progress of a specified import task.

GET

/v1/vector/collections/import/get

Base URL

该 API 的 Base URL 格式如下：

https://controller.api.${CLOUD_REGION}.zilliz.com.cn

📘说明

• 你需要将 ${CLOUD_REGION} 替换为您的集群所在区域。
• 获取云区域 ID 请参考 Zilliz Cloud 控制台 或使用查看云区域接口。

export CLOUD_REGION="ali-cn-hangzhou"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zilliz.com.cn"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。

示例值：Bearer {{TOKEN}}

jobIdstringqueryrequired

The ID of the import task in concern

示例值：job-xxxxxxxxxxxxxxxxxx

clusterIdstringqueryrequired

The ID of a cluster to which this operation applies.

示例值：inxx-xxxxxxxxxxxxxxx

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 "Content-Type: application/json"

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

指定导入任务的进度详情。

fileNamestring

The path of the data file object in the object storage.

fileSizeinteger<int64>

The size of the data file object.

readyPercentagenumber<float>

The indicator of the import progress

completeTimestring

The time at which the import task completes. null indicates that the file import is going on.

errorMessagestring

The message that explains the reason for an import failure. null indicates that no error occurs.

collectionNamestring

The target collection name of the import task.

jobIdstring

The ID of an import task.

detailsarray

The import task details

[]detailsobject

A list of import progress details per data files

fileNamestring

The path to a file being imported.

fileSizeinteger<int64>

The size of a file being imported.

readyPercentagenumber<float>

The import progress of a specific file.

completeTimestring

The time at which the import progress ends for a specific file. null indicates that the file import is going on.

errorMessagestring

The message that explains the reason for an import failure. null indicates that no error occurs.

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "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
            }
        ]
    }
}