导出备份文件

本接口可将指定集群的备份文件导出到指定的存储中。

POST

/v2/clusters/{CLUSTER_ID}/backups/{BACKUP_ID}/export

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

CLUSTER_IDstringpathrequired

The ID of the cluster that needs to be backed up.

示例值：inxx-xxxxxxxxxxxxxxx

BACKUP_IDstringpathrequired

The ID of the backup in concern.

示例值：backup-xxxxxxxxxxxxxxx

请求体application/json

integrationIdstring

备份文件导出到的外部存储的 ID。关于如何配置对象存储，请参阅文档。关于如何获取外部存储桶的集成 ID，可以参考文档。

示例值：integ-xxxxxxxxxxxxxxxxxxx

directorystring

备份文件导出到的外部存储的目录。

示例值：destdir/

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export BACKUP_ID="backup-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}/export" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "integrationId": "integ-xxxxxxx",
    "directory": "destdir/"
}'

响应200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

响应负载，为导出备份文件的任务 ID。

jobIdstring

导出备份文件的任务 ID。

示例值：job_xxxxxxxxxxxxxxx

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "jobId": "job-0396450098cglufig6afm9"
    }
}