この API を呼び出して、指定した ApsaraDB for PolarDB クラスターの自動バックアップポリシーを照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
DBClusterId String 必須 pc-bpxxxxxxx

ApsaraDB for PolarDB クラスターの ID を設定します。
AccessKeyId String 任意 key-test

Alibaba Cloud から提供された AccessKey ID を設定します。
Action String 任意 DescribeBackupPolicy

実行する API ( DescribeBackupPolicy) を設定します。

レスポンスパラメーター

パラメーター データ型 例 説明
BackupRetentionPeriod Integer 7

バックアップデータの保存期間を示します。
PreferredBackupPeriod String Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday

データのバックアップ期間を示します。 設定可能な値は以下のとおりです。

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
PreferredBackupTime String 14:00Z-15:00Z

自動バックアップの時刻を示します。 時刻は UTC で表示されます。
PreferredNextBackupTime String 2019-07-27T14:32Z

次回のバックアップ時刻を示します。 時刻は UTC で表示されます。
RequestId String 36590CA1-BAEE-4034-9CDD-33FFEC8C6BAE

リクエストの ID を示します。

コーディング例

リクエスト例


http(s)://[Endpoint]/? Action=DescribeBackupPolicy
&DBClusterId=pc-bpxxxxxxx
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<DescribeBackupPolicyResponse>
  <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>
      <RequestId>36590CA1-BAEE-4034-9CDD-33FFEC8C6BAE</RequestId>
      <PreferredBackupTime>14:00Z-15:00Z</PreferredBackupTime>
      <PreferredNextBackupTime>2019-07-27T14:32Z</PreferredNextBackupTime>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
</DescribeBackupPolicyResponse>

JSON 形式 

{
	"PreferredBackupPeriod":"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
	"RequestId":"36590CA1-BAEE-4034-9CDD-33FFEC8C6BAE",
	"BackupRetentionPeriod":7,
	"PreferredNextBackupTime":"2019-07-27T14:32Z",
	"PreferredBackupTime":"14:00Z-15:00Z"
}

エラーコード

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