查看备份列表 (V2)

List all AVAILABLE or CREATING backups. Note that this API only applies to dedicated clusters.

GET

/v2/backups

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

projectIdstringquery

备份所属项目的 ID。

clusterIdstringquery

备份所属集群的 ID。

creationMethodstringquery

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

枚举值：

MANUALAUTO

backupTypestringquery

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

枚举值：

CLUSTERCOLLECTION

startTimestringquery

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

endTimestringquery

Zilliz Cloud 完成该备份的时间。

pageSizestringquery

每页显示的记录数。

currentPagestringquery

要显示的页码。

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/backups" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

响应负载，为备份列表。

countinteger

返回的备份总数。

currentPageinteger

当前页码。

pageSizeinteger

每页记录数。

backupsarray

备份列表。

[]backupsobject

备份的详细信息。

projectIdstring

包含该备份的项目 ID。

backupIdstring

备份 ID。

backupNamestring

备份名称。

backupTypestring

备份中包含的资源类型。

枚举值：

CLUSTERCOLLECTION

creationMethodstring

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

枚举值：

AUTOMANUAL

sizeinteger

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

expireTimestring

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

clusterIdstring

数据被备份的集群 ID。

clusterNamestring

数据被备份的集群名称。

createTimestring

集群创建时间。

statusstring

备份状态。

枚举值：

AVAILABLECREATING

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "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"
            }
        ]
    }
}