跳到主要内容

导出快照 (V2)

申请开通

将 Collection 快照导出到已配置的对象存储。

POST/v2/vectordb/jobs/snapshot/export
连接端点

该 API 的 Base URL 格式如下：

https://{cluster-id}.{region}.vectordb.zilliz.com.cn:19530

📘说明
  • 如果您使用的是服务集群，请使用集群端点。

    • Free 与 Serverless 版

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated 版

      https://{cluster-id}.{region}.vectordb.zilliz.com.cn:19530

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

shell
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zilliz.com.cn:19530"
参数
Authorizationstringheader

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

示例值：Bearer {{TOKEN}}
请求体application/json
dbNamestring

Collection 所属数据库名称。

collectionNamestring必填项

要创建快照的 Collection 名称。

snapshotNamestring必填项

快照名称。

targetS3Pathstring必填项

Milvus 写入导出快照数据和元数据的 S3 兼容对象存储根路径。该值应为可写的 URI，例如 s3://bucket-name/export-root。Milvus 会在此根路径下追加快照专属的元数据路径；响应中返回生成的 snapshotMetadataURI。

externalSpecstring

可选的外部对象存储配置 JSON。当 targetS3Path 指向 Milvus 管理 bucket 之外的存储时，可传入 extfs 对象以覆盖 Milvus 访问该 bucket 的方式。支持的 JSON 字段：

  • format："parquet"、"lance-table" 或 "vortex"；省略或整个值为空时默认为 "parquet"。
  • columns：可选的要加载的列名数组。
  • extfs：可选的对象存储覆盖配置。允许的键包括 cloud_provider、region、use_iam、use_ssl、use_virtual_host、iam_endpoint、storage_type、ssl_ca_cert、access_key_id 和 access_key_value。

要求：

  • 值必须是合法 JSON。
  • format 必须是上述支持值之一。
  • extfs 的键必须位于允许列表中，不支持的键会被拒绝。
  • use_iam、use_ssl、use_virtual_host 必须是字符串 "true" 或 "false"。
  • 仅当目标 bucket 需要与 Milvus 管理 bucket 不同的凭据或连接设置时才使用 extfs。如需使用默认的 Milvus 管理存储，请省略 externalSpec 或传入空字符串。

示例：{"format":"parquet","extfs":{"cloud_provider":"aws","region":"us-west-2","use_iam":"true"}}。

bash
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/jobs/snapshot/export" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "default",
    "collectionName": "my_collection",
    "snapshotName": "snapshot_2026_01",
    "targetS3Path": "s3://bucket-name/export-root",
    "externalSpec": ""
}'
响应200 OK - application/json

将 Collection 快照导出到已配置的对象存储。

codeinteger必填项

响应码。

dataobject必填项
snapshotMetadataURIstring必填项

导出快照元数据在对象存储中的 URI。

codeinteger必填项

响应码。

messagestring必填项

错误描述。

Successjson
{
    "code": 0,
    "data": {
        "snapshotMetadataURI": "s3://bucket/snapshots/snapshot_2026_01"
    }
}
Ctrl I