获取备份策略

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

export BASE_URL="https://api.cloud.zilliz.com"

参数

Authorizationstringheaderrequired

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

示例值：Bearer {{TOKEN}}

CLUSTER_IDstringpathrequired

The ID of the cluster whose backup is in concern.

示例值：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

SUCCESS

codeinteger

Response code.

dataobject

Response payload which is the backup policy of the specified cluster.

clusterIdstring

The ID of the cluster whose backup policy is in concern.

statusstring

The status of the backup policy.

枚举值：

ENABLEDDISABLED

startTimestring

The start time is a two hour duration for the backup policy to execute in the format of HH:mm-HH:mm UTC time. When the backup policy is disabled, the value is null.

示例值：02:00-04:00

frequencystring

The week days on which the backup is performed. The value is a comma-separated list of numbers from 1 to 7, where 1 represents Monday and 7 represents Sunday. When the backup policy is disabled, the value is null.

示例值：1,2,5

retentionDaysinteger

The number of days to retain the backup. When the backup policy is disabled, the value is 0.

取值范围：≥ 1≤ 30

示例值：7

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "status": "ENABLED",
        "startTime": "02:00-04:00",
        "frequency": "1,2,3,5",
        "retentionDays": 7
    }
}