跳到主要内容

查看备份详情 (V2)

List the information about the specified backup in detail. Note that this API only applies to dedicated clusters.

GET
/v2/clusters/{CLUSTER_ID}/backups/{BACKUP_ID}
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
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export BACKUP_ID="backup-xxxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
响应200 - application/json
codeinteger

响应码。

dataobject

响应负载，为备份的详细信息。

clusterIdstring

包含该备份的集群 ID。

示例值：inxx-xxxxxxxxxxxxxxx
clusterNamestring

包含该备份的集群名称。

projectIdstring

包含被备份集群的项目 ID。

backupIdstring

备份 ID。

示例值：Dedicated-01_backup3
backupNamestring

备份名称。

backupTypestring

备份的资源类型。

creationMethodstring

备份的创建方式，是手动创建还是自动创建。

statusstring

备份的当前状态。

sizeinteger

备份的大小，单位为字节。

regionIdstring

备份所在的云区域 ID。

expireTimestring

备份的过期时间。

dbCollectionsarray

备份中包含的数据库及其集合列表。

[]dbCollectionsobject

A database and its collections that are included in the backup.

dbNamestring

数据库名称。

collectionsarray

备份中包含的集合。

[]collectionsobject

集合信息。

collectionNamestring

集合名称。

descriptionstring

集合描述。

statusstring

集合的加载状态。

createTimestring

The time at which the backup was created.

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

{
    "code": 0,
    "data": {
        "clusterId": "in01-31a6b840e50b72d",
        "clusterName": "Dediacted-01",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "backupId": "backup0_1e3c0988ecb7f0d",
        "backupName": "Dedicated-01_backup1",
        "backupType": "CLUSTER",
        "creationMethod": "MANUAL",
        "status": "AVAILABLE",
        "size": 112,
        "regionId": "aws-us-west-2",
        "expireTime": "2024-08-30T16:49:50Z",
        "collections": [
            {
                "collectionName": "medium_articles",
                "description": "Sample collection",
                "status": "LOADED"
            }
        ],
        "createTime": "2024-07-30T16:49:50Z"
    }
}