CreateBackup操作を呼び出して、インスタンスのバックアップファイルを作成できます。

この操作では、ApsaraDB RDSのバックアップ機能を使用してバックアップファイルを作成します。 データベースバックアップ (DBS) の操作を使用して、バックアップファイルを作成することもできます。

この API を呼び出す場合、インスタンスは次の要件を満たしている必要があります。

  • インスタンスのステータスは [実行中] です。
  • インスタンスには進行中のバックアップタスクがありません。
  • インスタンスの1日に作成されるバックアップファイルの数は20を超えることはできません。

デバッグ

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

リクエストパラメーター

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

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

DBInstanceIdString必須rm-uf6wjk5 ****

インスタンスの ID です。

DBNameString任意rds_mysql

データをバックアップするデータベースの名前。 データベースの名前はコンマ (,) で区切ります。

説明 このパラメーターは、ApsaraDB RDS for MySQLインスタンスの個々のデータベースで論理バックアップを実行するときに指定できます。 ApsaraDB RDS for SQL Serverインスタンスの個々のデータベースで完全物理バックアップを実行するときにも、このパラメーターを指定できます。
BackupStrategyString任意db

バックアップファイルに使用するポリシー。 有効な値：

  • db: データベースレベルのバックアップ。
  • instance: インスタンスレベルのバックアップ。
説明 このパラメーターは、ApsaraDB RDS for MySQLインスタンスで論理バックアップを実行するときに指定できます。 ApsaraDB RDS for SQL Serverインスタンスで完全物理バックアップを実行するときにも、このパラメーターを指定できます。
BackupMethodString任意Physical

実行するバックアップの種類。 有効な値：

  • 論理: 論理バックアップ
  • Physical: 物理バックアップ
  • Snapshot: スナップショットバックアップ

デフォルト値: Physical。

説明
  • インスタンスにデータベースが作成されている場合にのみ、論理バックアップを実行できます。
  • ApsaraDB RDS for MariaDB TXインスタンスでスナップショットバックアップを実行する場合、このパラメーターをPhysicalに設定する必要があります。
  • サポートされているバックアップタイプの詳細については、「ApsaraDB RDS For MySQLインスタンスのバックアップ」をご参照ください。
  • 標準SSDまたは拡張SSD (ESSD) を使用するApsaraDB RDS for SQL Serverインスタンスでスナップショットバックアップを実行する場合、このパラメーターをスナップショットに設定する必要があります。
BackupTypeString任意Auto

バックアップ方法。 有効な値：

  • 自動: システムは、完全バックアップまたは増分バックアップを実行するかどうかを決定します
  • FullBackup: 完全バックアップ。

デフォルト値: Auto。

説明
  • このパラメーターは、インスタンスがSQL Serverデータベースエンジンを実行する場合にのみ設定する必要があります。
  • このパラメーターは、BackupMethodパラメーターがPhysicalに設定されている場合にのみ有効です。
ResourceGroupIdString任意rg-acfmy *****

リソースグループの ID です。

レスポンスパラメーター

項目データ型例:説明　
BackupJobIdString5073731

バックアップタスクのID。

RequestIdString2C125605-266F-41CA-8AC5-3A643D4F42C5

リクエストの ID です。

例

リクエストの例

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

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

XML 形式

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

<?xml version="1.0" encoding="UTF-8" ?>
<CreateBackupResponse>
    <RequestId>2C125605-266F-41CA-8AC5-3A643D4F42C5</RequestId>
    <BackupJobId>5073731</BackupJobId>
</CreateBackupResponse>

JSON 形式

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

{
  "RequestId" : "2C125605-266F-41CA-8AC5-3A643D4F42C5" 、
  "BackupJobId" : "5073731"
}

エラーコード

HTTP ステータスコードエラーコードエラーメッセージ説明　
403OperationDenied.ApiForbidden操作は許可されません。現在の操作がサポートされていない場合に返されるエラーメッセージ。

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