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

バックアップポリシーの取得 (V2)

指定したクラスターのバックアップポリシーを詳細に一覧表示します。なお、この API は専用クラスターにのみ適用されます。

GET/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
bash
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 "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

response

codeinteger

レスポンスコード。

dataobject

指定したクラスターのバックアップポリシーを含むレスポンスペイロード。

clusterIdstring

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

statusstring

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

startTimestring

開始時刻は、バックアップポリシーが実行される 2 時間の期間で、形式は HH:mm-HH:mm UTC time です。バックアップポリシーが無効な場合、値は null です。

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

バックアップが実行される曜日。値は 1 から 7 までの数値をカンマ区切りで並べたリストで、1 は Monday、7 は Sunday を表します。バックアップポリシーが無効な場合、値は null です。

値の例： 1,2,5
retentionDaysinteger

バックアップを保持する日数。バックアップポリシーが無効な場合、値は 0 です。

値の範囲： ≥ 1≤ 30
値の例： 7
crossRegionCopiesarray

クロスリージョンバックアップポリシーのリスト。リスト内の各エントリにより、永続バックアップのコピーが指定したリージョンに 1 つ作成されます。

[]crossRegionCopiesobject

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

regionIdstring

バックアップのコピー先となるターゲットクラウドリージョンの ID。

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

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

値の範囲： ≥ 1≤ 30
値の例： 7
regionstring

リージョンコード。

値の例： us-west-2

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Ctrl I