查看导入任务列表

This operation lists all import jobs of a specific cluster.

POST

/v2/vectordb/jobs/import/list

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

clusterIdstring必填项

Zilliz Cloud 上的特定集群的 ID。

pageSizeinteger

每次返回的记录数。

currentPageinteger

当前页码。

dbNamestring

Name of the database to which the import job belongs.

export TOKEN="YOUR_API_KEY"

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

响应200 - application/json

OPTION 1

codestring

响应码。

dataobject

响应负载，为导入任务详情列表。

countinteger

本次返回的记录总数。

currentPageinteger

当前页码。

pageSizeinteger

每次返回包含的最大记录数。

recordsarray

导入任务详情列表。

[]recordsobject

An import job in detail.

collectionNamestring

当前导入任务的目标 Collection 名称。

jobIdstring

当前导入任务的 ID。

statestring

当前导入任务的状态。

枚举值：

PendingInProgressCompletedFailed

OPTION 2

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "records": [
            {
                "collectionName": "test_collection",
                "jobId": "job-xxxxxxxxxxxxxxxxxxxxx",
                "state": "Completed"
            }
        ]
    }
}

FAILURE

{
    "code": 21119,
    "message": "The apikey is illegal."
}