ApsaraDB for ClickHouseクラスターのバックアップポリシーを照会します。

注 この操作は、バージョン20.3のApsaraDB for ClickHouseクラスターでのみ使用できます。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeBackupPolicy

実行する操作です。 値をDescribeBackupPolicyに設定します。

DBClusterId String 必須 cc-bp1qx68m06981 ****

クラスターの ID を示します。

レスポンスパラメーター

パラメーター データ型 例 説明
PreferredBackupPeriod String Monday

バックアップが実行される間隔。 設定可能な値は以下のとおりです。

  • 月曜日: 毎週月曜日
  • 火曜日: 毎週火曜日
  • 水曜日: 毎週水曜日
  • 木曜日: 毎週木曜日
  • 金曜日: 毎週金曜日
  • 土曜日: 毎週土曜日
  • 日曜日: 毎週日曜日
切り替え String true

バックアップ機能が有効かどうかを示します。 設定可能な値は以下のとおりです。

  • true: 有効
  • false: 無効
RequestId String F5178C10-1407-4987-9133-DE4DC9119F75

リクエストの ID です。

PreferredBackupTime String 15:00Z-16:00Z

バックアップウィンドウ。 バックアップウィンドウの先頭と末尾がUTCで表示されます。

BackupRetentionPeriod Integer 7

データバックアップファイルの保存期間。 有効な値: 7 ~ 730 単位は日です。

例

リクエストの例

http(s):// clickhouse.aliyuncs.com/?Action=DescribeBackupPolicy
&DBClusterId=cc-bp1qx68m06981 ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupPolicyResponse>
    <PreferredBackupPeriod> 月曜日 </PreferredBackupPeriod>
    <Switch>true</Switch>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PreferredBackupTime>15:00Z-16:00Z</PreferredBackupTime>
    <BackupRetentionPeriod>7</BackupRetentionPeriod>
</DescribeBackupPolicyResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PreferredBackupPeriod" : "月曜日" 、
  "スイッチ" : true、
  "RequestId" : "F5178C10-1407-4987-9133-DE4DC9119F75" 、
  "PreferredBackupTime" : "15:00Z-16:00Z" 、
  「BackupRetentionPeriod」: 7
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 指定されたクラスター ID が存在しない場合に返されるエラーメッセージ。 指定されたDBClusterIdパラメーターが有効かどうかを確認します。

エラーコードリストについては、「API エラーセンター」をご参照ください。