この API は、既存データを新しいクローンインスタンスに復元します。
操作説明
関連機能ドキュメント
関連機能ドキュメント
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rds:CloneDBInstance |
create |
DBInstance
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するクライアント生成トークンです。これにより、重複リクエストを防止できます。トークンはリクエスト間で一意である必要があり、ASCII 文字のみを含み、長さは 64 文字以内である必要があります。 |
0c593ea1-3bea-11e9-b96b-88********** |
| RegionId |
string |
任意 |
リージョン ID です。DescribeRegions 操作を呼び出して、リージョン ID を照会できます。 |
cn-hangzhou |
| ZoneId |
string |
任意 |
新規インスタンスの可用性ゾーン ID です。DescribeRegions 操作を呼び出して、可用性ゾーン ID を照会できます。 説明
このパラメーターを指定しない場合、ソースインスタンスの可用性ゾーンが使用されます。 |
cn-hangzhou-b |
| DBInstanceClass |
string |
任意 |
新規インスタンスのインスタンスタイプです。詳細については、「インスタンスタイプ」をご参照ください。 説明
このパラメーターを指定しない場合、ソースインスタンスのインスタンスタイプが使用されます。 |
mysql.n1.micro.1 |
| DBInstanceStorage |
integer |
任意 |
インスタンスのストレージ容量です。単位:GB。値は 5 GB 単位で指定する必要があります。詳細については、「インスタンスタイプ」をご参照ください。 説明
このパラメーターを指定しない場合、ソースインスタンスのストレージ容量が使用されます。 |
1000 |
| DBInstanceDescription |
string |
任意 |
新規インスタンスの説明です。説明は 2~255 文字である必要があります。先頭は英字または漢字で始まり、英字、数字、漢字、アンダースコア (_)、ハイフン (-) を含めることができます。 説明
説明は |
testInstance |
| DbNames |
string |
任意 |
ソースインスタンスからクローンするデータベースをカンマ区切りのリストで指定します。 |
test1,test2 |
| PayType |
string |
必須 |
課金方法です。有効な値は次のとおりです。
|
Postpaid |
| InstanceNetworkType |
string |
任意 |
インスタンスのネットワークタイプです。有効な値は次のとおりです。
説明
このパラメーターを指定しない場合、ソースインスタンスのネットワークタイプが使用されます。 |
VPC |
| DBInstanceId |
string |
必須 |
クローンするソースインスタンスの ID です。 |
rm-uf6wjk5**** |
| BackupId |
string |
任意 |
バックアップ ID です。 DescribeBackups 操作を呼び出して、バックアップの一覧を照会できます。 説明
BackupId および RestoreTime のいずれか一方は必ず指定する必要があります。 |
902**** |
| RestoreTime |
string |
任意 |
データを復元する時点です。時刻はバックアップ保持期間内である必要があります。yyyy-MM-ddTHH:mm:ssZ 形式 (UTC) で指定します。 説明
BackupId および RestoreTime のいずれか一方は必ず指定する必要があります。 |
2011-06-11T16:00:00Z |
| VPCId |
string |
任意 |
VPC ID です。 説明
VPC が指定されたリージョンに属していることを確認してください。 |
vpc-uf6f7l4fg90**** |
| VSwitchId |
string |
任意 |
vSwitch ID です。vSwitch は ZoneId パラメーターで指定された可用性ゾーン内にある必要があります。
|
vsw-uf6adz52c2p**** |
| PrivateIpAddress |
string |
任意 |
新規インスタンスのプライベート IP アドレスです。IP アドレスは、指定された vSwitch の IP アドレス範囲内である必要があります。このパラメーターを指定しない場合、システムは指定された VPCId および VSwitchId に基づいて自動的にプライベート IP アドレスを割り当てます。 |
172.XX.XX.69 |
| UsedTime |
integer |
任意 |
サブスクリプション期間です。有効な値は次のとおりです。
説明
PayType を Prepaid に設定した場合、このパラメーターは必須です。 |
1 |
| Period |
string |
任意 |
UsedTime パラメーターで指定されたサブスクリプション期間の単位です。有効な値は次のとおりです。
説明
PayType を Prepaid に設定した場合、このパラメーターは必須です。 |
Year |
| Category |
string |
任意 |
インスタンスエディションです。有効な値は次のとおりです。
サーバーレスインスタンス
説明
このパラメーターを指定しない場合、新規インスタンスはソースインスタンスと同じエディションで作成されます。 |
HighAvailability |
| ZoneIdSlave1 |
string |
任意 |
セカンダリノードの可用性ゾーン ID です。ZoneId パラメーターと同じ値を設定すると、インスタンスはシングル AZ デプロイメントを使用します。異なる値を設定すると、インスタンスはマルチ AZ デプロイメントを使用します。 |
cn-hangzhou-c |
| ZoneIdSlave2 |
string |
任意 |
ロガーノードの可用性ゾーン ID です。ZoneId パラメーターと同じ値を設定すると、インスタンスはシングル AZ デプロイメントを使用します。異なる値を設定すると、インスタンスはマルチ AZ デプロイメントを使用します。 |
cn-hangzhou-d |
| DBInstanceStorageType |
string |
任意 |
インスタンスのストレージタイプです。有効な値は次のとおりです。
説明
サーバーレスインスタンスは、ESSD PL1 クラウドディスクおよび Enhanced SSD (ESSD) のみをサポートしています。 |
general_essd |
| RestoreTable |
string |
任意 |
特定のデータベースまたはテーブルのみを復元するには、このパラメーターを 1 に設定します。 |
1 |
| TableMeta |
string |
任意 |
復元するデータベースおよびテーブルを JSON 文字列で指定します。RestoreTable が 1 に設定されている場合、このパラメーターは必須です。値は次の形式である必要があります。
|
[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}] |
| DedicatedHostGroupId |
string |
任意 |
専用クラスターの ID です。 |
dhg-7a9**** |
| BackupType |
string |
任意 |
バックアップタイプです。有効な値は次のとおりです。
|
FullBackup |
| DeletionProtection |
boolean |
任意 |
削除保護を有効にするかどうかを指定します。有効な値は次のとおりです。
|
true |
| IoAccelerationEnabled |
string |
任意 |
このパラメーターは、インスタンスをサーバーレスインスタンスにクローンする場合にのみ適用されます。 説明
このパラメーターは中国本土でのみ利用可能です。 |
0 |
| BurstingEnabled |
boolean |
任意 |
このパラメーターは非推奨です。使用しないでください。 |
false |
| AutoPay |
boolean |
任意 |
自動支払いを有効にするかどうかを指定します。有効な値は次のとおりです。
説明
PayType を Prepaid に設定した場合、このパラメーターは必須であり、true に設定する必要があります。 |
true |
| CustomExtraInfo |
string |
任意 |
Enhanced SSD (ESSD) の I/O バーストを有効にするかどうかを指定します。
説明
I/O バーストの詳細については、「Enhanced SSD (ESSD) とは」をご参照ください。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
リクエストに対して返されるデータです。 |
||
| DBInstanceId |
string |
新規インスタンスの ID です。 |
rm-uf6wjk5**** |
| OrderId |
string |
購入注文の ID です。 |
100789370**** |
| RequestId |
string |
このリクエストの一意な ID です。 |
1E43AAE0-BEE8-43DA-860D-EAF2**** |
例
成功レスポンス
JSONJSON
{
"DBInstanceId": "rm-uf6wjk5****",
"OrderId": "100789370****",
"RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2****"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidAvZone.Format | Specified AvZone is not valid. | |
| 400 | InvalidAvZone.NotSupport | Specified availableArea multiZone does not support in RDS. | |
| 400 | CannotDecreaseEssdPerfLevel | cannot decrease cloud essd performance level. | |
| 400 | InvalidIPAddress.Conflict | IP address conflict. | |
| 400 | CDDC.AvailableHostsNotEnoughInZone | Not enough available hosts are in the target zone. | |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | |
| 400 | InvalidRecoveryDbInstance.StorageType | The disk local_ssd can not clone to cloud disk type | |
| 400 | InvalidRecoveryDbInstance.StorageSize | The disk space of the new instance cannot be less than that of the current instance | |
| 400 | InvalidDBInstanceClass.Offline | The specified instance type is no longer provided. Please specify another instance type. | |
| 400 | InvalidTunnelId | Specified conn tunnel is not valid. | |
| 400 | ZoneId.NotMatchWithCategory | The number of available zones does not match the database engine or instance edition. Please reset it. | |
| 400 | UnsupportExtendDisk.NotSupport | Specified DB instance is unsupport extend disk. | |
| 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 | 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 | StopService.Clone | The service has been discontinued and cloning operations on classic network instances are no longer permitted. | |
| 400 | InvalidParam.UsedTime | The clone expiration date cannot exceed %s. | |
| 400 | MinorVersionTag.NotFound | Minor version tags cannot be parsed by the instance. | |
| 400 | InvalidBakset.Invalid | Specified bakset is not valid. | |
| 400 | InvalidParamForXfs | Xfs instance must be single tenant standard instance. | |
| 400 | AtLeastThreeVSwitchAvailableIp | The primary vswitch requires at least three available IP addresses. | |
| 400 | AtLeastTwoVSwitchAvailableIp | The primary vswitch requires at least two available IP addresses. | |
| 400 | DiskSize.NotEnough | The disk size is not enough to restore tables. | |
| 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 | IncorrectMinorVersion | Current engine minor version does not support operations. | |
| 403 | IncorrectCharacterType | Current DB instance character type does not support this operation. | |
| 403 | CloudDiskEncryptionNotSupport | The encryption key is not allowed for general-purpose instance. | |
| 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 | 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. | |
| 403 | InvalidMeta.TooLarge | Meta information is too large. | |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。