跳到主要内容

创建导入任务 (V2)

This operation imports the prepared data files to a Zilliz Cloud cluster. To learn how to prepare your data files, read Prepare Data Import.

POST
/v2/vectordb/jobs/import/create
Base URL

该 API 的 Base URL 格式如下：

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

📘说明

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

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

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

示例值：Bearer {{TOKEN}}
请求体application/json
clusterIdstring必填项

Collection 所属的集群 ID。设置为不存在的集群将导致错误。您可以通过调用 /v2/clusters 端点获取集群 ID，或从 Zilliz Cloud 控制台 复制集群 ID。

示例值：inxx-xxxxxxxxxxxxxxxx
dbNamestring

Collection 所属的数据库名称。设置为不存在的数据库将导致错误。

collectionNamestring必填项

目标 Collection 的名称。设置为不存在的 Collection 将导致错误。

partitionNamestring

目标 Partition 的名称。设置为不存在的 Partition 将导致错误。

volumeNamestring

数据文件上传的源 volume 名称。该 volume 需事先创建。详情请参考 创建 volume

dataPathsarray

待上传的数据文件路径列表。路径应相对于指定 volume 的根目录。

[]dataPathsarray

待上传的数据文件路径列表。每个列表包含一个路径。

clusterIdstring必填项

Collection 所属的集群 ID。设置为不存在的集群将导致错误。您可以通过调用 /v2/clusters 端点获取集群 ID，或从 Zilliz Cloud 控制台 复制集群 ID。

示例值：inxx-xxxxxxxxxxxxxxxx
dbNamestring

Collection 所属的数据库名称。设置为不存在的数据库将导致错误。

collectionNamestring必填项

目标 Collection 的名称。设置为不存在的 Collection 将导致错误。

partitionNamestring

目标 Partition 的名称。设置为不存在的 Partition 将导致错误。

objectUrlstring

待导入数据的 URL。该 URL 应来自与诸如阿里云 OSS 或腾讯云 COS 等与 MinIO S3 兼容的对象存储服务。

objectUrlsarray

待批量导入的对象 URL列表。
当前支持的文件类型及如何在同一个任务中批量导入多个相同类型的数据文件，可参考：

[]objectUrlsarray

待导入 Entity 所在的数据文件或文件夹 URL 列表。每个 列表包含一个 URL。

accessKeystring

对象存储服务的访问密钥 (AK)。

secretKeystring

对象存储服务的访问密钥 (SK)。

tokenstring

A temporary token for you to access the object storage service. The token name and the way to obtain it may vary with cloud providers. For details, refer to the FAQ.

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/vectordb/jobs/import/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "clusterId": "inxx-xxxxxxxxxxxxxxx",
    "dbName": "default",
    "collectionName": "medium_articles",
    "partitionName": "",
    "volumeName": "my_volume",
    "dataPaths": [
        [
            "json-folder/1.json"
        ]
    ]
}'
响应200 - application/json
codeinteger

响应码。

示例值：0
dataarray

响应负载，包含了当前操作创建的批量导入任务的 ID。

[]dataobject

一个已创建的批量导入任务。

jobIdstring

当前创建的批量导入任务 ID。

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

{
    "code": 0,
    "data": {
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxx"
    }
}