ModifyInstanceCrossBackupPolicy操作を呼び出して、ApsaraDB RDSインスタンスのクロスリージョンバックアップ設定を変更できます。

この操作を呼び出す前に、ソースインスタンスが次のデータベースエンジンのいずれかを実行していることを確認してください。

デバッグ

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

リクエストパラメーター

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

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

DBInstanceId String 必須 rm-uf6wjk5xxxxxxxxxx

インスタンスの ID です。

RegionId String 必須 cn-hangzhou

ソースインスタンスが属するリージョンのID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

CrossBackupType String いいえ 1

インスタンスのクロスリージョンバックアップファイルを保存するために使用されるポリシー。 値を1に設定します。 値1は、すべてのクロスリージョンバックアップファイルが保存されることを指定します。

LogBackupEnabled String いいえ 1

インスタンスのクロスリージョンログバックアップ機能のステータス。 有効な値：

  • 0: 機能を無効にします。
  • 1: 機能を有効にします。
説明 クロスリージョンログバックアップ機能が有効になっている場合にのみ、クロスリージョンログバックアップ機能を有効にできます。
BackupEnabled String いいえ 1

インスタンスのクロスリージョンバックアップ機能のステータス。 このパラメーターは、データとログをバックアップできるかどうかを指定します。 有効な値：

  • 0: 機能を無効にします。
  • 1: 機能を有効にします。
説明 クロスリージョンバックアップ機能を有効にする前に、CrossBackupRegionパラメーターを設定する必要があります。
CrossBackupRegion String 任意 cn-shanghai

インスタンスのクロスリージョンバックアップファイルが格納されているターゲットリージョンのID。

RetentType Integer いいえ 1

インスタンスのクロスリージョンバックアップファイルを保持するために使用されるポリシー。 値を1に設定します。 値1は、インスタンスのクロスリージョンバックアップファイルが、指定された保持期間に基づいて保持されることを指定します。

Retention Integer いいえ 7

インスタンスのクロスリージョンバックアップファイルが保持される日数。 有効な値: 7 ~ 1825

レスポンスパラメーター

項目 データ型 例: 説明
BackupEnabled String 有効にする

インスタンスのクロスリージョンバックアップ機能のステータス。 有効な値：

  • 無効化
  • 有効
RegionId String cn-hangzhou

ソースインスタンスが属するリージョンのID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

LogBackupEnabled String 有効にする

インスタンスのクロスリージョンログバックアップ機能のステータス。 有効な値：

  • 無効化
  • 有効
RequestId String 50A6059D-6DBB-46C6-A851-1EE93C9013CF

リクエストの ID です。

RetentType Integer 1

インスタンスのクロスリージョンバックアップファイルを保持するために使用されるポリシー。 既定値：1 値1は、インスタンスのクロスリージョンバックアップファイルが、指定された保持期間に基づいて保持されることを示します。

CrossBackupRegion String cn-shanghai

インスタンスのクロスリージョンバックアップファイルが格納されているターゲットリージョンのID。

CrossBackupType String 1

インスタンスのクロスリージョンバックアップファイルを保存するために使用されるポリシー。 既定値：1 値1は、すべてのクロスリージョンバックアップファイルが保存されていることを示します。

Retention Integer 15

インスタンスのクロスリージョンバックアップファイルが保持される日数。 有効な値: 7 ~ 1825

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

インスタンスの ID です。

例

リクエストの例

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

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

XML 形式 

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

<ModifyInstanceCrossBackupPolicyResponse>
<CrossBackupType>1</CrossBackupType>
    <LogBackupEnabled> 有効化 </LogBackupEnabled>
    <BackupEnabled> 有効化 </BackupEnabled>
    <CrossBackupRegion>cn-shanghai</CrossBackupRegion>
    <RetentType>1</RetentType>
    <RequestId>50A6059D-6DBB-46C6-A851-1EE93C9013CF</RequestId>
    <DBInstanceId>rm-bpxxxxx</DBInstanceId>
    <RegionId>cn-hangzhou</RegionId>
    <StorageType>oss</StorageType>
    <Endpoint></Endpoint>
    <Retention>15</Retention>
</ModifyInstanceCrossBackupPolicyResponse>

JSON 形式 

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

{
  "CrossBackupType" : "1" 、
  "LogBackupEnabled" : "有効" 、
  "BackupEnabled" : "イネーブル" 、
  "CrossBackupRegion" : "cn-shanghai" 、
  "RetentType" : 1、
  "RequestId" : "50A6059D-6DBB-46C6-A851-1EE93C9013CF" 、
  "DBInstanceId" : "rm-bpxxxxx" 、
  "RegionId" : "cn-hangzhou" 、
  "StorageType" : "oss" 、
  "Endpoint" : "" 、
  「保持」: 15
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 ParameterLeastAssociate 少なくとも1つのオプションパラメータを入力する必要があります。 インスタンスのrestoreTimeパラメーターとBackupIdパラメーターを同時に空にすることができない場合に返されるエラーメッセージ。 パラメーターの少なくとも1つを設定し、再試行する必要があります。
400 InvalidRegion. フォーマット 指定されたリージョンは無効です。 指定されたリージョンが無効な場合に返されるエラーメッセージ。
400 OperationDenied.SwitchToCrossRegionBackup スナップショットバックアップは、現在、クロスリージョンバックアップストレージをサポートしていません。 クロスリージョンバックアップとストレージがスナップショットバックアップでサポートされていない場合に返されるエラーメッセージ。
400 OperationDenied.SwitchToSnapshot スナップショットバックアップは現在、クロスリージョンストレージをサポートしていません。 スナップショットバックアップモードに切り替える前に、クロスリージョンバックアップをオフにしてください。 インスタンスが存在するリージョンとは異なるリージョンにスナップショットバックアップファイルを保存できない場合に返されるエラーメッセージ。 スナップショットバックアップ機能を有効にする前に、クロスリージョンバックアップ機能を無効にする必要があります。
400 OperationDenied.SwitchSnapshotToPhysical スナップショットバックアップへの物理バックアップのみがサポートされています。 操作が物理バックアップ方式からスナップショットバックアップ方式への変更のみをサポートしている場合に返されるエラーメッセージ。
403 IncorrectEngineVersion 現在のエンジンバージョンは操作をサポートしていません。 インスタンスで実行されているデータベースエンジンバージョンでは、この操作がサポートされていない場合に返されるエラーメッセージ。
403 IncorrectDBInstanceType 現在のDBインスタンスタイプは、この操作をサポートしていません。 インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
403 IncorrectDBInstanceEngine 現在のDBインスタンスエンジンはこの操作をサポートしていません。 インスタンスのデータベースエンジンがこの操作をサポートしていない場合に返されるエラーメッセージ。
403 IncorrectDBInstanceLockMode 現在のDBインスタンスロックモードはこの操作に対応していません。 インスタンスがロックされている場合に返されるエラーメッセージ。
403 IncorrectDBInstanceState 現在のDBインスタンスの状態は、この操作をサポートしていません。 インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
404 InvalidDBInstance.NotFound 指定されたインスタンスが存在しないか、サポートされていません。 インスタンスが見つからない、削除されている、または操作をサポートしていない場合に返されるエラーメッセージ。

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