メインコンテンツまでスキップ

バックアップポリシーの設定 (V2)

指定したクラスターのバックアップポリシーを設定し、Zilliz Cloud が指定した間隔でクラスターを自動的にバックアップするようにします。なお、この API は dedicated cluster にのみ適用されます。

POST/v2/clusters/{CLUSTER_ID}/backups/policy
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つ API key である必要があります。

値の例： Bearer {{TOKEN}}
CLUSTER_IDstringpath必要

バックアップ対象のクラスターの ID。

値の例： inxx-xxxxxxxxxxxxxxx
リクエスト・ボディapplication/json
frequencystring

バックアップを実行する曜日です。値は 1 から 7 までの数値をカンマ区切りで指定します。1 は月曜日、7 は日曜日を表します。

値の例： 1,2,5
startTimestring

開始時刻は、バックアップポリシーを実行する 2 時間の時間帯を HH:mm-HH:mm UTC time 形式で指定します。

値の例： 02:00-04:00
retentionDaysinteger

バックアップを保持する日数。

値の範囲： ≥ 1≤ 30
値の例： 7
enabledboolean必要

自動バックアップを有効にするかどうか。

値の例：
crossRegionCopiesarray

クロスリージョンバックアップポリシーの一覧。

[]crossRegionCopiesobject

クロスリージョンバックアップポリシーに関する情報。

regionIdstring

バックアップのコピー先となる対象クラウドリージョンの ID。このリージョンは、指定したクラスターが属するプロジェクトに関連付けられている必要があります。

値の例： aws-us-west-2
retentionDaysinteger

クロスリージョンバックアップを保持する日数。

値の範囲： ≥ 1≤ 30
値の例： 7
bash
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/policy" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "frequency": "1,2,3,5",
    "startTime": "02:00-04:00",
    "retentionDays": 7,
    "enabled": true
}'
bash
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/policy" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "enabled": false
}'
レスポンス200 OK - application/json

レスポンス

codeinteger

レスポンスコード。

dataobject
clusterIdstring

バックアップポリシーの対象となるクラスターの ID。

statusstring

バックアップポリシーのステータス。

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "status": "ENABLED"
    }
}
Ctrl I