[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

Get Backup Policy (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

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

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

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

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.

Possible Values:

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.

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

crossRegionCopiesarray

The list of cross-region backup policies. Each entry in the list results in one copy of the permanent backup being created in the specified region.

[]crossRegionCopiesobject

Information about the cross-region backup policy.

regionIdstring

The ID of the target cloud region to which the backup will be copied.

Example Value: aws-us-west-2

retentionDaysinteger

The number of days to retain the cross-region backup.

Value Range: ≥ 1≤ 30

Example Value: 7

regionstring

The region code.

Example Value: us-west-2

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "status": "ENABLED",
        "startTime": "02:00-04:00",
        "frequency": "1,2,3,5",
        "retentionDays": 7,
        "crossRegionCopies": [
            {
                "regionId": "aws-us-west-2",
                "retentionDays": 7,
                "region": "us-west-2"
            },
            {
                "regionId": "aws-us-east-1",
                "retentionDays": 7,
                "region": "us-east-1"
            }
        ]
    }
}