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

バックアップポリシーを取得 (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"
レスポンス

response

バックアップポリシーに対して返される成功レスポンスボディ。

codeinteger<int32>

レスポンスコード。

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<int32>

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

値の例: 7
crossRegionPoliciesarray

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

[]crossRegionPoliciesobject

インスタンスのクロスリージョンバックアップポリシーデータ。

regionIdstring

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

retentionDaysinteger<int32>

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

regionstring

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

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。