跳到主要内容

获取备份策略 (V2)

List the backup policy of the specified cluster in detail. Note that this API only applies to dedicated clusters.

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

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

响应码。

dataobject

响应负载，为指定集群的备份策略。

clusterIdstring

备份策略所属集群的 ID。

statusstring

备份策略的状态。

startTimestring

备份策略执行的开始时间，为 UTC 时间，格式为 HH:mm-HH:mm。当备份策略被禁用时，该值为 null。

示例值：02:00-04:00
frequencystring

备份执行的星期几。该值为 1 到 7 之间的逗号分隔数字列表，其中 1 代表星期一，7 代表星期日。当备份策略被禁用时，该值为 null。

示例值：1,2,5
retentionDaysinteger

备份保留的天数。当备份策略被禁用时，该值为 0。

取值范围：≥ 1≤ 30
示例值：7
crossRegionCopiesarray

跨区域备份策略列表。列表中的每条记录都会在指定区域创建一个永久保留的备份副本。

[]crossRegionCopiesobject

跨区域备份策略信息。

regionIdstring

目标云区域 ID。

示例值：ali-cn-hangzhou
retentionDaysinteger

跨区域备份保留的天数。

取值范围：≥ 1≤ 30
示例值：7
regionstring

区域代码。

示例值：cn-hangzhou

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "status": "ENABLED",
        "startTime": "02:00-04:00",
        "frequency": "1,2,3,5",
        "retentionDays": 7,
        "crossRegionCopies": [
            {
                "regionId": "ali-cn-hangzhou",
                "retentionDays": 7,
                "region": "cn-hangzhou"
            },
            {
                "regionId": "ali-cn-shanghai",
                "retentionDays": 7,
                "region": "cn-shanghai"
            }
        ]
    }
}