查看导入任务列表

List all import jobs specific to a cluster.

GET

/v1/vector/collections/import/list

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}}

clusterIdstringqueryrequired

The ID of a specific cluster on Zilliz Cloud.

示例值：inxx-xxxxxxxxxxxxxxx

pageSizestringquery

The number of records to return at each request.

示例值：10

currentPagestringquery

The current page number.

示例值：1

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/vector/collections/import/list?clusterId=inxx-xxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

响应200 - application/json

SUCCESS

codestring

响应码。

dataobject

响应负载，包含所有导入任务的详细信息。

countstring

本次响应中列出的记录总数。

currentPagestring

用于参考的当前页码。

pageSizestring

每页返回的最大记录数。

tasksarray

导入任务的详细列表。

[]tasksobject

A import job in detail.

collectionNamestring

导入任务的目标 Collection 名称。

jobIdstring

导入任务的 ID。

statestring

导入任务的对应状态。可能的值为 ImportRunning、ImportCompleted 和 ImportFailed。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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