DescribeBackupPolicy操作を呼び出して、インスタンスのバックアップ設定を照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須/任意 例: 説明 
操作 String 必須 DescribeBackupPolicy

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

DBInstanceId String 必須 rm-uf6wjk5xxxxxxx

インスタンスの ID です。

BackupPolicyMode String 任意 DataBackupPolicy

バックアップの種類。 有効な値:

  • DataBackupPolicy: データバックアップ
  • LogBackupPolicy: ログバックアップ
CompressType String いいえ 1

バックアップデータの圧縮に使用されるメソッド。 有効な値:

  • 0: バックアップデータは圧縮されません。
  • 1: zlibを使用してバックアップデータを圧縮します。
  • 2: バックアップデータは、バックアップごとに複数のスレッドを並行して呼び出すzlibを使用して圧縮されます。
  • 4: バックアップデータはQuickLZを使用して圧縮され、個々のデータベースとテーブルを復元するために使用できます。
  • 8: バックアップデータはQuickLZを使用して圧縮されますが、個々のデータベースやテーブルの復元には使用できません。 この値は、インスタンスがMySQL 8.0を実行している場合にのみ使用できます。
ReleasedKeepPolicy String 任意 最新

インスタンスがリリースされた場合にアーカイブバックアップファイルを保持するために使用されるポリシー。 有効な値:

  • None: アーカイブされたバックアップファイルは保持されません。
  • Lastest: 最後にアーカイブされたバックアップファイルのみが保持されます。
  • すべて: すべてのアーカイブバックアップファイルが保持されます。

レスポンスパラメーター

項目 データ型 例: 説明 
LogBackupRetentionPeriod Integer 7

ログバックアップファイルが保持される日数。

ArchiveBackupKeepPolicy String ByMonth

アーカイブされたバックアップファイルが保持されるサイクル。

ArchiveBackupKeepCount String 1

保持されているアーカイブバックアップファイルの数。

LocalLogRetentionHours Integer 0

ログバックアップファイルがインスタンスに保持されている時間数。

BackupRetentionPeriod Integer 7

データバックアップファイルが保持される日数。

RequestId String B87E2AB3-B7C9-4394-9160-7F639F732031

リクエストの ID です。

PreferredBackupPeriod String Monday,Wednesday,Friday,Sunday

バックアップを実行するサイクル。 複数入力する場合は、カンマ (,) で区切ります。 有効な値:

  • 月曜日
  • 火曜日
  • 水曜日
  • 木曜日
  • 金曜日
  • 土曜日
  • 日曜日
CompressType String 1

バックアップデータの圧縮に使用されるメソッド。 有効な値:

  • 0: バックアップデータは圧縮されません。
  • 1: zlibを使用してバックアップデータを圧縮します。
  • 2: バックアップデータは、バックアップごとに複数のスレッドを並行して呼び出すzlibを使用して圧縮されます。
  • 4: バックアップデータはQuickLZを使用して圧縮され、個々のデータベースとテーブルを復元するために使用できます。
  • 8: バックアップデータはQuickLZを使用して圧縮されますが、個々のデータベースやテーブルの復元には使用できません。 この値は、インスタンスがMySQL 8.0を実行している場合にのみ使用できます。
SupportReleasedKeep Integer 0

予約済みのパラメーター。

LocalLogRetentionSpace String 30

インスタンス上のログバックアップファイルに許可されている最大ディスク使用率。

SupportVolumeShadowCopy Integer 1

インスタンスがスナップショットバックアップをサポートしているかどうかを示します。 有効な値:

  • 1: インスタンスはスナップショットバックアップをサポートしています。
  • 0: インスタンスはスナップショットバックアップをサポートしていません。
説明 このパラメーターは、インスタンスがSQL Serverを実行している場合にのみ返されます。
BackupMethod String Physical

インスタンスのバックアップ方式。 有効な値:

  • Physical: 物理バックアップ
  • Snapshot: スナップショットバックアップ
説明 このパラメーターは、インスタンスがSQL Serverを実行し、標準SSDまたは拡張SSD (ESSD) を使用している場合にのみ返されます。
LogBackupFrequency String LogInterval

ログのバックアップ頻度。 有効な値:

  • LogInterval: ログバックアップは30分ごとに実行されます。
  • デフォルト値: PreferredBackupPeriodパラメーターの値と同じです。
説明 LogBackupFrequencyパラメーターは、インスタンスがSQL Serverを実行している場合にのみ返されます。
PreferredNextBackupTime String 2018-01-19T15:15Z

次のバックアップが実行される時刻。 時間はyyyy-MM-dd T HH:mm Z形式のISO 8601標準に従います。 時刻は UTC で表示されます。

HighSpaceUsageProtection String 有効にする

ログバックアップ削除機能が有効かどうかを示します。 ディスク使用率が80% を超える場合、またはインスタンスの残りのディスク容量が5 GB未満の場合、この機能はバイナリーログファイルを削除します。 有効な値:

  • 無効化
  • 有効
ArchiveBackupRetentionPeriod String 365

アーカイブされたバックアップファイルが保持される日数。

BackupInterval String 30

バックアップ間隔。 単位: 分。

  • インスタンスがMySQLを実行している場合、間隔はApsaraDB RDSコンソールのSnapshot Backup Start Timeパラメーター (Snapshot Backup Periodパラメーターではない) の値と同じです。 詳細については、「ApsaraDB RDS for MySQL インスタンスのバックアップ」をご参照ください。
  • インスタンスがSQL Serverを実行している場合、間隔はログバックアップの頻度と同じです。
ReleasedKeepPolicy String なし

インスタンスがリリースされた場合にアーカイブバックアップファイルを保持するために使用されるポリシー。 有効な値:

  • None: アーカイブされたバックアップファイルは保持されません。
  • Lastest: 最後にアーカイブされたバックアップファイルのみが保持されます。
  • すべて: すべてのアーカイブバックアップファイルが保持されます。
PreferredBackupTime String 15:00Z-16:00Z

データバックアップが実行された時刻。 時間は、HH:mm Z − HH:mm ZフォーマットのISO 8601規格に従う。 時刻は UTC で表示されます。

LogBackupLocalRetentionNumber Integer 60

インスタンスに保持されているバイナリログファイルの数。

カテゴリー String スタンダード

1桁の2番目のバックアップ機能を有効にするかどうかを示します。 この機能により、ApsaraDB RDSは1桁の秒以内にバックアップを完了できます。 有効な値:

  • Flash: 1桁の2番目のバックアップ機能が有効になっています。
  • 標準: 1桁の2番目のバックアップ機能は無効です。
説明 このパラメーターは、BackupPolicyModeパラメーターをDataBackupPolicyに設定した場合にのみ有効になります。
EnableBackupLog String 1

ログバックアップ機能が有効かどうかを示します。 有効な値:

  • 1: ログバックアップ機能が有効になっています。
  • 0: ログバックアップ機能は無効です。
BackupLog String 有効にする

ログバックアップ機能が有効かどうかを示します。 有効な値:

  • 有効
  • 無効
EnableIncrementDataBackup ブール 正しい

増分バックアップが有効かどうかを示します。 有効な値:

  • True: 増分バックアップが有効です。
  • False: 増分バックアップは無効です。

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&<共通リクエストパラメーター>

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

XML 形式

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

<DescribeBackupPolicyResponse>
<カテゴリ> 標準 </カテゴリ>
<ArchiveBackupRetentionPeriod>0</ArchiveBackupRetentionPeriod>
<RequestId>292884FE-D689-47A2-9829-C05E63366201</RequestId>
<複製 />
<ReleasedKeepPolicy> なし </ReleasedKeepPolicy>
<ArchiveBackupKeepPolicy>ByMonth</ArchiveBackupKeepPolicy>
<PreferredBackupTime>00:00Z-01:00Z</PreferredBackupTime>
<LocalLogRetentionHours>18</LocalLogRetentionHours>
<PreferredNextBackupTime>2021-01-07T00:40Z</PreferredNextBackupTime>
<HighSpaceUsageProtection> 有効化 </HighSpaceUsageProtection>
<CompressType>1</CompressType>
<LogBackupFrequency>LogInterval</LogBackupFrequency>
<PreferredBackupPeriod> 火曜日、木曜日、土曜日 </PreferredBackupPeriod>
<ArchiveBackupKeepCount>1</ArchiveBackupKeepCount>
<LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>
<LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
<BackupLog> 有効化 </BackupLog>
<EnableBackupLog>1</EnableBackupLog>
<SupportReleasedKeep>0</SupportReleasedKeep>
<SupportVolumeShadowCopy>1</SupportVolumeShadowCopy>
<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
<BackupRetentionPeriod>10</BackupRetentionPeriod>
<DuplicationContent/>
<BackupInterval>30</BackupInterval>
</DescribeBackupPolicyResponse>

JSON 形式

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

{
  "カテゴリ" : "標準" 、
  "ArchiveBackupRetentionPeriod" : 0、
  "RequestId" : "292884FE-D689-47A2-9829-C05E63366201" 、
  "重複" : "" 、
  "ReleasedKeepPolicy" : "なし" 、
  "ArchiveBackupKeepPolicy" : "ByMonth" 、
  "PreferredBackupTime" : "00:00Z-01:00Z" 、
  "LocalLogRetentionHours" : "18" 、
  "PreferredNextBackupTime" : "2021-01-07T00:40Z" 、
  "HighSpaceUsageProtection" : "有効" 、
  "CompressType" : "1" 、
  "LogBackupFrequency" : "LogInterval" 、
  "PreferredBackupPeriod" : "火曜日、木曜日、土曜日" 、
  "ArchiveBackupKeepCount" : 1、
  "LogBackupRetentionPeriod" : "7" 、
  "LogBackupLocalRetentionNumber" : 60、
  "BackupLog" : "有効" 、
  "EnableBackupLog" : "1" 、
  "SupportReleasedKeep" : 0、
  "SupportVolumeShadowCopy" : 1、
  "LocalLogRetentionSpace" : "30" 、
  "BackupRetentionPeriod" : 10、
  "DuplicationContent" : "" 、
  "BackupInterval" : "30"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明 
400 IO. 例外 IO例外、後で再試行します。 I/Oエラーが発生した場合に返されるエラーメッセージ。
400 InternalFailure 内部障害、後で再試行します。 リクエストが失敗した場合に返されるエラーメッセージ。 しばらくしてからもう一度お試しください。
400 InvalidParameter.OwnerAccount 指定されたパラメーターOwnerAccountは無効です。 OwnerAccountパラメーターの値が無効な場合に返されるエラーメッセージ。 値を確認します。
404 InvalidDBInstance.NotFound 指定されたインスタンスが存在しないか、サポートされていません。 インスタンスが見つからない、削除されている、または操作をサポートしていない場合に返されるエラーメッセージ。

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