恢复集群备份 (V2)

Restore cluster backup to a new dedicated cluster of the same CU type in the same cloud region. Note that this API only applies to dedicated clusters.

POST

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

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

需要备份的集群的 ID。

示例值：inxx-xxxxxxxxxxxxxxx

BACKUP_IDstringpathrequired

需要导出的备份的 ID。

示例值：backup-xxxxxxxxxxxxxxx

请求体application/json

projectIdstring必填项

恢复后的集群所属的项目 ID。

clusterNamestring必填项

恢复后的集群名称。

cuSizeinteger必填项

恢复后的集群的 CU 大小。

取值范围：≥ 1≤ 1024

collectionStatusstring必填项

恢复后的集群中 Collection 的状态。

枚举值：

KEEPRELEASE

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}/restoreCluster" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxx",
    "clusterName": "Dedicated-12",
    "cuSize": 2,
    "collectionStatus": "KEEP"
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

响应负载，包含恢复后的集群信息。

clusterIdstring

恢复后的集群 ID。

usernamestring

用于访问恢复后集群的用户名。

passwordstring

用于访问恢复后集群的密码。该密码仅显示一次，建议您记录该密码并将其保存在安全的地方。

jobIdstring

本次请求创建的集群恢复任务的 ID。

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "username": "db_admin",
        "password": "xxxxxxxxx",
        "jobId": "job-xxxxxxxxxxxxxx"
    }
}