跳到主要内容

查看备份列表 (V2)

本接口可查看所有处于 AVAILABLE 或 CREATING 状态的备份记录。仅适用于 Dedicated 集群。

GET/v2/backups
连接端点

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com

📘说明

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

shell
export BASE_URL="https://api.cloud.zilliz.com"
参数
Authorizationstringheader必填项

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

示例值：Bearer {{TOKEN}}
projectIdstringquery

备份所属项目的 ID。

clusterIdstringquery

备份所属集群的 ID。

creationMethodstringquery

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

backupTypestringquery

备份文件中包含的资源类型。

startstringquery

Zilliz Cloud 开始创建该备份的时间。

endstringquery

Zilliz Cloud 完成该备份的时间。

pageSizeintegerquery

每页显示的记录数。

currentPageintegerquery

要显示的页码。

bash
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/backups" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
响应200 OK - application/json

response

该操作可能返回的响应体之一。

codeinteger<int32>

响应码。

dataobject

响应负载，为备份列表。

countinteger<int32>

返回的备份总数。

currentPageinteger<int32>

当前页码。

pageSizeinteger<int32>

每页记录数。

backupsarray

备份列表。

[]backupsobject

备份的详细信息。

backupIdstring

备份 ID。

projectIdstring

包含该备份的项目 ID。

backupNamestring

备份名称。

backupTypestring

备份中包含的资源类型。

creationMethodstring

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

statusstring

备份状态。

sizeinteger<int64>

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

expireTimestring<date-time>

备份将被自动删除的时间。

clusterIdstring

数据被备份的集群 ID。

clusterNamestring

数据被备份的集群名称。

createTimestring<date-time>

集群创建时间。

restoreNewInstancePoliciesarray

从备份恢复新集群的策略。仅适用于 CLUSTER 类型的备份。

[]restoreNewInstancePoliciesstring

从备份恢复新集群的策略。可能的值包括：

  • LATEST：恢复集群到最新的兼容 GA Milvus 版本。
  • ORIGINAL：恢复集群到其原始的兼容 Milvus 版本。

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

Successjson
{
    "code": 0,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "backups": [
            {
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxx",
                "backupId": "backupx_xxxxxxxxxxxxxxxx",
                "backupName": "Dedicated-01_backup1",
                "backupType": "CLUSTER",
                "creationMethod": "AUTO",
                "size": 112,
                "expireTime": "2024-08-30T16:49:50Z",
                "clusterId": "inxx-xxxxxxxxxxxxxx",
                "clusterName": "Dedicated-01",
                "createTime": "2024-07-30T16:49:50Z",
                "status": "AVAILABLE",
                "restoreNewInstancePolicies": [
                    "LATEST",
                    "ORIGINAL"
                ]
            }
        ]
    }
}
Ctrl I