该接口用于重建已进入回收站的实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:CreateDBInstanceForRebuild | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-uf6wjk5**** |
PayType | string | 是 | 目标实例的付费类型,取值:
| Postpaid |
SecurityIPList | string | 否 | 该实例的IP白名单。多条记录请以半角逗号(,)隔开,不可重复,最多1000条记录。支持如下两种格式:
如不填则默认为原实例default分组白名单信息。 | 127.0.0.1 |
DBInstanceDescription | string | 否 | 目标实例名称,长度为2~256个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。 说明
不能以 http:// 和 https:// 开头。
| testdb |
ZoneId | string | 否 | 主节点可用区ID。可以通过接口DescribeRegions查看可用区ID。 说明
指定了VPC和交换机时,为匹配交换机对应的可用区,该参数必填。
| cn-hangzhou-e |
ZoneIdSlave1 | string | 否 | 备可用区1。 说明
非基础版实例需要传入该参数。
| cn-hangzhou-c |
ZoneIdSlave2 | string | 否 | 备可用区2。 说明
仅三节点企业版实例可传入该参数。
| cn-hangzhou-d |
VPCId | string | 否 | 目标实例的VPC ID。当InstanceNetworkType=VPC时,本参数必须配置。 说明
如果传入此参数,您还需要传入参数ZoneId。
| vpc-uf6f7l4fg90**** |
VSwitchId | string | 否 | 虚拟交换机ID。虚拟交换机所在的可用区必须和ZoneId中传入的可用区ID相对应。 说明
| vsw-uf6adz52c2p**** |
Period | string | 否 | 指定预付费实例为包年或者包月类型,取值:
说明
若付费类型为Prepaid则该参数必须传入。
| Month |
UsedTime | string | 否 | 指定购买时长。取值:
说明
若PayType为Prepaid,需要传入该参数。
| 1 |
ClientToken | string | 否 | 该参数用于保证请求的幂等性,防止重复提交请求。参数值由客户端生成,保证在不同请求间唯一。 该参数值由ASCII字符组成,最长不超过64个字符,不能包含非ASCII字符。 | ETnLKlblzczshOTUbOC**** |
DBInstanceNetType | string | 否 | 实例的网络连接类型,取值:
| Internet |
InstanceNetworkType | string | 否 | 目标实例的网络类型,取值:
默认创建经典网络类型的实例。 说明
当本参数值为VPC时,还需要传入参数VpcId、VSwitchId。
| VPC |
ResourceGroupId | string | 否 | 资源组ID,可以为空。 | rg-acfmy**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"Message": "success",
"DBInstanceId": "rm-uf6wjk5****",
"TaskId": "417450000",
"OrderId": "20793850608****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | RR309 | We have detected a security risk with your payment method. Please proceed with verification via the link in your email or console message and re-submit your order after verification. | 我们检测到您的付款方式存在安全风险。请通过电子邮件或控制台消息中的链接继续验证,并在验证后重新提交订单。 |
400 | GeneralIns.Creating | The general instance is creating. | 目前有实例还在生产中,请稍等 |
400 | InvalidZone.NotSupportedForStorageType | The specified zone is closed or invalid for Specified DBInstanceStorageType. | 指定的区域已关闭或对于指定的DBInstanceStorageType无效。 |
400 | GeneralIns.Maintaining | The general instance is maintaining. | 有实例在迁移或维护中,请稍等 |
400 | GeneralIns.Switching | The general instance is Switching. | HA切换中,请稍等 |
400 | InvalidEngine.VauleNotSupported | The specified parameter "Engine" is not valid. | 数据库类型不正确。请选用以下几种数据库类型:MySQL/SQLServer/PostgreSQL/PPAS。 |
400 | InvalidEngineVersion.ValueNotSupported | The specified parameter "EngineVersion" is not valid. | 数据库版本验证失败。 数据库版本号取值范围: MySQL:5.5/5.6/5.7; SQLServer:2008r2/2012; PostgreSQL:9.4; PPAS:9.3。 |
400 | InvalidDBinstanceClass.ValueNotSupported | The specified parameter DBinstanceClass is invalid. | 指定的参数“实例规格”无效 |
400 | InvalidDBInstanceStorage.ValueNotSupported | The specified parameter "DBInstanceStorage" is not valid. | 实例存储设置无效。请重新设置存储。各引擎支持的存储范围如下:MySQL支持5至1000GB;SQLServer支持10至1000GB;PostgreSQL和PPAS支持5至2000GB。 |
400 | InvalidDBInstanceDescription.Malformed | The specified parameter "DBInstanceDescription" is not valid. | 实例备注验证失败。格式要求:实例备注不能超过256个字节,不能以http:// , https://开头,必须以中文、英文字母开头。可以包含中文、英文字符、”_”,” -”,数字字符长度2~256。 |
400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list | 指定的安全IP列表无效。其中包含重复值。 |
400 | InvalidSecurityIPListLength.Malformed | The quota of security ip exceeds. | 已超过安全IP数量上限。 |
400 | DefaultVpc.NotSupport | The default vpc create is not support. | 操作失败,您的阿里云账号不支持默认VPC网络,请先创建VPC网络和交换机。 |
400 | Forbidden.RegionNotFound | The provided RegionId does not exist in our record. | 操作失败,当前提供的地域标识在记录中不存在。 |
400 | InvalidVpcIdOrVswitchId.NotSupported | The specified vpcId or vSwitchId is not supported. | 指定的vpcId或者vSwitchId不支持,请检查实例信息 |
400 | InvalidVpcId.NotSupported | The specified vpcId or vSwitchId is not supported. | 操作失败,VPC或交换机不正确。请检查VPC或交换机是否和RDS在同一可用区。 |
400 | InvalidZoneId.NotSupported | The Specified vpc Zone not supported. | 当前可用区不支持创建VPC网络类型实例,请更换可用区。 |
400 | VswitchIpExhausted | No available ip in the specified vswitch. | 指定的vswitch中没有可用的IP。 |
400 | InvalidGeneralGroupName.Malformed | The specified parameter GeneralGroupName is not valid. | 参数 GeneralGroupName 不合法. |
400 | AccountBasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | 您的信息不完整。在操作前完善您的信息。 |
400 | IncorrecttVpcId | The specified parameter VPCId is not valid. | VPCId无效。请您选择正确的VPC网络。 |
400 | OperationDenied.DBInstanceStatus | Operation is denied by the current database instance status. | 操作失败,当前数据库实例状态不支持。 |
400 | InvalidDBInstanceClass.Offline | The specified instance type is no longer provided. Please specify another instance type. | 当前所选的实例规格已下线,请更换其他实例规格。 |
403 | ClassicNetworkType.NotSupport | The Classic instance network create is not support. | 操作失败,当前实例不支持创建经典网络类型,请创建其他网络类型的实例。 |
403 | InvalidEngineVersionInRegion.NotAvailable | The EngineVersion in the Region is not available. | 操作失败,当前地域不支持该引擎版本。 |
403 | OperationDenied | The specified request is out of resources. | 指定请求资源不足。 |
403 | QuotaExceeded.CreateInstance | The quota of create instance exceeds. | 已超过实例数量上限。请释放不需要的实例。 |
403 | Forbidden.Authentication | The operation is forbidden by Aliyun Realname Authentication System. | 操作失败,该操作被阿里云实名认证系统禁止。 |
403 | INST_HAS_UNPAID_ORDER | The instanceId has unpaid order. | 实例存在未支付订单,请先完成结算或作废订单后重试。 |
403 | COMMODITY.FAILED | The commodity is error. | 服务器异常,请提交运维同学处理。 |
403 | MoneyLessThan100 | The Account Monet less Than 100. | 当前阿里云账号余额不足100,请充值。 |
403 | OperationDenied.ClassicNetworkType | The operation is not permitted due to status of instance. | 操作失败,经典网络类型不支持此操作。 |
404 | InvalidDBInstanceId.NotFound | Invalid DBInstanceId NotFound. | 实例不存在。请确认该实例是否在当前账号下。 |
404 | CreateOrder.Failed | Create Order Failed. | 创建订单失败。 |
404 | InvalidRegionId.NotFound | The provided RegionId does not exist in our records. | 该地域不存在,请重新设置。 |
404 | QueryPrice.Failed | QueryPrice Failed. | 询价失败,请联系客服同学。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-04-06 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-03-16 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|