恢复 Collection 备份 (V2)

Restore collection backup to an existing cluster. Note that this API only applies to dedicated clusters.

POST

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

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

Collection 备份所属集群的 ID。

示例值：inxx-xxxxxxxxxxxxxxx

BACKUP_IDstringpathrequired

需要恢复的备份的 ID。

示例值：Dedicated-01_backup3

请求体application/json

destClusterIdstring必填项

恢复后的 Collection 所属集群的 ID。

dbCollectionsarray

Collection 组列表。

[]dbCollectionsobject

Collection 组。

dbNamestring

包含 collectionNames 字段中列出的 Collection 的源数据库名称。

destDbNamestring

指定 Collection 将被恢复到的目标数据库名称。

collectionsarray

目前，Zilliz Cloud 一次仅恢复一个 Collection。因此，在列表中仅包含一个 Collection 名称。如果未指定此项，备份中的所有 Collection 将以未加载状态恢复到目标集群中。

[]collectionsobject

要恢复的 Collection。

collectionNamestring

要恢复的源 Collection 的名称。

destCollectionNamestring

目标 Collection 的名称。

destCollectionStatusstring

目标 Collection 的状态。

枚举值：

LOADEDUNLOADED

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export BACKUP_ID="Dedicated-01_backup3"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}/restoreCollection" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "destClusterId": "in01-xxxxxxxxxxxxxx",
    "dbCollections": [
        {
            "collections": [
                {
                    "collectionName": "medium_articles",
                    "destCollectionName": "restore_medium_articles",
                    "destCollectionStatus": "LOADED"
                }
            ]
        }
    ]
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

响应负载，包含异步控制平面任务的 ID。

jobIdstring

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

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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