导入

Imports data from files stored in a specified object storage bucket.

POST

/v1/vector/collections/import

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

请求体application/json

clusterIdstring必填项

集群 ID。

collectionNamestring必填项

Collection 名称。

partitionNamestring

Partition 名称。

objectUrlstring必填项

存储待导入数据的对象 URL。

accessKeystring

用于访问指定对象的 Access Key。

secretKeystring

用于访问指定对象的 Secret Key。

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v1/vector/collections/import" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "clusterId": "inxx-xxxxxxxxxxxxxxx",
    "collectionName": "medium_articles",
    "objectUrl": "gs://docs-demo/1af78216-xxxx-2b0a73c566ed/1.parquet",
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

响应载荷，为一个包含导入任务 ID 的对象。

jobIdstring必填项

提交的导入任务的 ID。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 200,
    "data": {
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx"
    }
}