この API は、自己管理 MySQL 5.7 データベースのバックアップデータを RDS にインポートするために使用されます。
操作説明
サポートされるエンジン
RDS MySQL
機能説明
ユーザーバックアップとは、自己管理 MySQL データベースからの完全バックアップデータを指します。ユーザーバックアップをクラウドに回復できます。
注意事項
この API を呼び出すには、次の条件を満たす必要があります:
XtraBackup を使用して自己管理 MySQL 5.7 または 8.0 データベースをバックアップ済みであり、バックアップファイル名が
_qp.xbで終わること。詳細については、「自己管理 MySQL 5.7 または 8.0 データベースからクラウドへの完全バックアップデータの移行」をご参照ください。自己管理 MySQL 5.7 または 8.0 データベースのバックアップファイルを、対応するリージョンの OSS バケットにアップロード済みであること。詳細については、「自己管理 MySQL 5.7 または 8.0 データベースからクラウドへの完全バックアップデータの移行」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rds:ImportUserBackupFile |
create |
*DBInstance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
インスタンスのリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。 説明
|
cn-hangzhou |
| Mode |
string |
任意 |
インポートモード。有効値:
|
oss |
| EngineVersion |
string |
任意 |
自己管理 MySQL データベースおよび ApsaraDB RDS for MySQL インスタンスで実行されるデータベースエンジンのバージョン。値を 5.7 に設定します。 |
5.7 |
| BucketRegion |
string |
任意 |
自己管理 MySQL データベースの完全バックアップファイルが格納されている OSS バケットのリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| BackupFile |
string |
任意 |
OSS バケットにオブジェクトとして保存されている完全バックアップファイルに関する情報で構成される JSON 配列。例: JSON 配列には次のフィールドが含まれます:
|
{"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"} |
| Comment |
string |
任意 |
完全バックアップファイルの説明。 |
BackupTest |
| RestoreSize |
integer |
任意 |
完全バックアップファイルのデータを復元するために必要なストレージ容量。単位:GB。 説明
|
20 |
| Retention |
integer |
任意 |
完全バックアップファイルの保持期間。単位:日。有効値:ゼロ以外の正の整数。 |
30 |
| ZoneId |
string |
任意 |
ゾーン ID。DescribeRegions 操作を呼び出して、ゾーン ID をクエリできます。 説明
|
cn-hangzhou-b |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。DescribeDBInstanceAttribute 操作を呼び出して、リソースグループ ID をクエリできます。 |
rg-acfmy**** |
| DBInstanceId |
string |
任意 |
インスタンス ID。 |
rm-uf6wjk5**** |
| SourceInfo |
string |
任意 |
完全バックアップのソース情報を提供する、大文字と小文字を区別する JSON 配列。例:
配列内のパラメーターは次のように記述されます:
説明
これはネイティブレプリケーションインスタンスにのみ適用され、API を呼び出す際に |
{"sourceIp":"172.20.xx.xx","sourcePort":"9999"} |
| BuildReplication |
boolean |
任意 |
レプリケーションを自動的に設定するかどうかを指定します。有効値:
説明
これはネイティブレプリケーションインスタンスにのみ適用され、API を呼び出す際に |
true |
| MasterInfo |
string |
任意 |
MySQL レプリケーションを設定するための Master 情報を含む、大文字と小文字を区別する JSON 配列。例:
配列内のパラメーターは次のように記述されます:
説明
これはネイティブレプリケーションインスタンスにのみ適用され、API を呼び出す際に |
{"masterIp":"172.20.xx.xx","masterPort":"3306","masterUser":"replica","masterPassword":"W33uopkehBQ="} |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| BackupId |
string |
完全バックアップファイルの ID。 |
b-n8tpg24c6i0v**** |
| RequestId |
string |
リクエスト ID。 |
A140DD14-DCC9-4548-9C72-52A49A58A310 |
| Status |
boolean |
完全バックアップファイルがインスタンスに正常にインポートされたかどうかを示します。完全バックアップファイルが正常にインポートされた場合は true が返されます。それ以外の場合は、エラーメッセージが返されます。 |
true |
例
成功レスポンス
JSONJSON
{
"BackupId": "b-n8tpg24c6i0v****",
"RequestId": "A140DD14-DCC9-4548-9C72-52A49A58A310",
"Status": true
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidOssBackupFile.InvalidFile | The specified OSS backup file is invalid. | |
| 400 | OperationDenied.Product | The product code is not supported. | |
| 400 | InvalidBackupFile.Format | The specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid. | |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | |
| 400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | |
| 400 | Price.CommoditySys | Commodity system call exception. | |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | |
| 400 | pay.noCreditCard | Account not bound to credit card. | |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | |
| 400 | Api.NotSupport | Specified api is not supported. | |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | |
| 400 | KmsApiError | User secret key invalid. | |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | |
| 400 | RequiredParam.NotFound | Required input param is not found. | |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | |
| 400 | Pay.NoCreditCard | No credit cards. | |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | |
| 400 | OrdTCommodityQueryError | Failed to query for product. | |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | |
| 400 | InvalidUserBakset | The user backup set to be imported is invalid. | |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | |
| 403 | NotInFlowController | Sorry,no permission. | |
| 403 | InvalidKmsKey | Kms key is disabled. | |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | |
| 404 | Request.NotFound | The requested resource is not available. | |
| 404 | HostInfo.NotFound | The specified host info is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。