跳到主要内容

查看导入任务列表 (V2)

本接口可列出当前集群的所有导入任务。

POST/v2/vectordb/jobs/import/list
连接端点

该 API 的 Base URL 格式如下:

https://api.cloud.zilliz.com

📘说明

控制面接口速率限制为单用户单接口每秒最多 20 个请求。

shell
export BASE_URL="https://api.cloud.zilliz.com"
参数
Authorizationstringheader必填项

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

示例值:Bearer {{TOKEN}}
Acceptstringheader

使用 application/json。

示例值:application/json
请求体

用于列出导入任务的请求体;当请求面向集群时,clusterId 为必填项。

clusterIdstring必填项

Zilliz Cloud 上的特定集群的 ID。

projectIdstring

Database 和 Collection 所属的项目 ID。设置为不存在的项目将导致错误。您可以通过调用 /v2/projects 端点获取项目 ID,或从 Zilliz Cloud 控制台 复制项目 ID。

说明
仅适用于 Zilliz Cloud 上的按需计算集群和数据库。
示例值:proj-xxxxxxxxxxxxxxxx
regionIdstring

Database 和 Collection 所属的地域 ID。设置为不存在的地域将导致错误。您可以通过调用 /v2/regions 端点获取地域 ID,或从 Zilliz Cloud 控制台 复制地域 ID。

说明
仅适用于 Zilliz Cloud 上的按需计算集群和数据库。
示例值:ali-cn-hangzhou
pageSizeinteger<int32>

每次返回的记录数。

currentPageinteger<int32>

当前页码。

dbNamestring

Name of the database to which the import job belongs.

bash
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 "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
"clusterId": "inxx-xxxxxxxxxxxxxxx"
}'
响应

返回导入任务列表。

导入任务列表请求成功后的响应体。

codeinteger<int32>

响应码。

dataobject

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

recordsarray

当前页的导入任务记录列表。

[]recordsobject

单个导入任务的摘要信息。

collectionNamestring

目标集合的名称。

jobIdstring

导入任务的 ID。

statestring

导入任务的状态。

countinteger<int32>

导入任务的总数。

currentPageinteger<int32>

当前页码。

pageSizeinteger<int32>

每页记录数。

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

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