Skip to main content

Get Backup Policy

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

The base URL for this API is in the following format:

https://api.cloud.zilliz.com

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

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
CLUSTER_IDstringpathrequired

The ID of the cluster whose backup is in concern.

Example Value: 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"
Responses200 - application/json
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.

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.

Example Value: 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.

Example Value: 1,2,5
retentionDaysinteger

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

Value Range: ≥ 1≤ 30
Example Value: 7

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

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