All Products
Search

This Product

    ApsaraDB RDS:CreateDBInstanceForRebuild

    Document Center

    ApsaraDB RDS:CreateDBInstanceForRebuild

    Last Updated:May 11, 2024

    Rebuilds an instance from the recycle bin.

    Operation description

    Supported database engines

    • RDS MySQL
    • RDS PostgreSQL
    • RDS SQL Server
    • RDS MariaDB

    References

    Note : Fees are generated if the call is successful. Before you call this operation, carefully read the following documentation:

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:CreateDBInstanceForRebuild
    • acs:rds:{#regionId}:{#accountId}:*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.

    		rm-uf6wjk5xxxxxxx
    PayTypestringYes

    The billing method of the destination instance. Valid values:

    • Postpaid: pay-as-you-go
    • Prepaid: subscription
    		Postpaid
    SecurityIPListstringNo

    The IP address whitelist of the serverless instance. For more information, see Use a database client or the CLI to connect to an ApsaraDB RDS for PostgreSQL instance. If the IP address whitelist contains more than one entry, separate the entries with commas (,). Each entry must be unique. You can specify up to 1,000 entries. The entries in the IP address whitelist must be in one of the following formats:

    • IP addresses, such as 10.10.XX.XX.
    • CIDR blocks, such as 10.10.XX.XX/24. In this example, 24 indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.

    If this parameter is not specified, the default IP address whitelist is used.

    		127.0.0.1
    DBInstanceDescriptionstringNo

    The name of the instance. The name must be 2 to 256 characters in length. The name can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

    Note : The name cannot start with http:// or https://.
    		Test database
    ZoneIdstringNo

    The zone ID of the primary instance. You can call the DescribeRegions operation to query the most recent zone list.

    Note If you specify a virtual private cloud (VPC) and a vSwitch, you must specify this parameter to identify the zone for the vSwitch.
    		cn-hangzhou-e
    ZoneIdSlave1stringNo

    The zone ID of the secondary instance.

    Note If the instance does not run RDS Basic Edition, you must specify this parameter.
    		cn-hangzhou-c
    ZoneIdSlave2stringNo

    The zone ID of the logger instance.

    Note This parameter is available only when the instance runs RDS Enterprise Edition.
    		cn-hangzhou-d
    VPCIdstringNo

    The VPC ID of the instance. If you set InstanceNetworkType to VPC, you must specify this parameter.

    Note : If you specify this parameter, you must also specify ZoneId.
    		vpc-uf6f7l4fg90xxxxxx
    VSwitchIdstringNo

    The ID of the vSwitch. The vSwitch must belong to the zone that is specified by ZoneId.

    Note

    • If you set InstanceNetworkType to VPC, you must also specify this parameter.

    • If you specify the ZoneSlaveId1 parameter, you must specify the IDs of two vSwitches for this parameter and separate the IDs with a comma (,).

    		vsw-uf6adz52c2pxxxxx
    PeriodstringNo

    The unit of the subscription duration. Valid values:

    • Year
    • Month
    Note If you set the PayType parameter to Prepaid, you must specify this parameter.
    		Month
    UsedTimestringNo

    The subscription duration of the instance. Valid values:

    • If you set Period to Year, the value of UsedTime ranges from 1 to 5.
    • If you set Period to Month, the value of UsedTime ranges from 1 to 11.
    Note If you set PayType to Prepaid, you must specify this parameter.
    		1
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.

    The token can contain only ASCII characters and cannot exceed 64 characters in length.

    		ETnLKlblzczshOTUbOCzxxxxxxx
    DBInstanceNetTypestringNo

    The type of the network connection to the instance. Valid values:

    • Internet
    • Intranet
    		Internet
    InstanceNetworkTypestringNo

    The network type of the instance. Valid values:

    • VPC
    • Classic

    Default value: Classic.

    Note The VPCId and VSwitchId parameters must be specified when this parameter is set to VPC.
    		VPC
    ResourceGroupIdstringNo

    The ID of the resource group. The value of this parameter can be NULL.

    		rg-acfmy*****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		1AD222E9-E606-4A42-BF6D-8A4442913CEF
    Messagestring

    The response parameters.

    		success
    DBInstanceIdstring

    The instance ID.

    		rm-uf6wjk5xxxxxxx
    TaskIdstring

    The ID of the task.

    		417450000
    OrderIdstring

    The ID of the order.

    		20793850608****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Message": "success",
  "DBInstanceId": "rm-uf6wjk5xxxxxxx",
  "TaskId": "417450000",
  "OrderId": "20793850608****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400RR309We 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.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.
    400GeneralIns.CreatingThe general instance is creating.An RDS instance is in production. Please wait.
    400InvalidZone.NotSupportedForStorageTypeThe specified zone is closed or invalid for Specified DBInstanceStorageType.-
    400GeneralIns.MaintainingThe general instance is maintaining.An RDS instance is being migrated or maintained. Please wait.
    400GeneralIns.SwitchingThe general instance is Switching.A switchover for high availability is in progress. Please wait.
    400InvalidEngine.VauleNotSupportedThe specified parameter "Engine" is not valid.The database engine is invalid. The database engine must be MySQL, SQL Server, PostgreSQL, or PPAS.
    400InvalidEngineVersion.ValueNotSupportedThe specified parameter "EngineVersion" is not valid.The version of database engines version failed the verification check. Valid values: MySQL: 5.5, 5.6, and 5.7. SQL Server: 2008r2 and 2012. PostgreSQL: 9.4. PPAS: 9.3.
    400InvalidDBinstanceClass.ValueNotSupportedThe specified parameter DBinstanceClass is invalid.The specified parameter DBinstanceClass is invalid.
    400InvalidDBInstanceStorage.ValueNotSupportedThe specified parameter "DBInstanceStorage" is not valid.-
    400InvalidDBInstanceDescription.MalformedThe specified parameter "DBInstanceDescription" is not valid.The instance description failed the verification check. The description must be 2 to 256 characters in length and can contain letters, underscores (_), and hyphens (-). The description must start with a letter and cannot start with http:// or https://.
    400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the listThe IP address whitelist is invalid. The whitelist contains duplicate entries.
    400InvalidSecurityIPListLength.MalformedThe quota of security ip exceeds.The number of IP addresses and CIDR blocks in the IP address whitelist reaches the upper limit.
    400DefaultVpc.NotSupportThe default vpc create is not support.
    400Forbidden.RegionNotFoundThe provided RegionId does not exist in our record.The operation failed. The region ID cannot be found.
    400InvalidVpcIdOrVswitchId.NotSupportedThe specified vpcId or vSwitchId is not supported.The VPC that is specified by the vpcId parameter or the vSwitch that is specified by the vSwitchId parameter is not supported. Check the values of these parameters.
    400InvalidVpcId.NotSupportedThe specified vpcId or vSwitchId is not supported.The operation failed. Check that the VPC or the vSwitch resides in the same zone as the RDS instance.
    400InvalidZoneId.NotSupportedThe Specified vpc Zone not supported.VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.
    400VswitchIpExhaustedNo available ip in the specified vswitch.No available IP address exists in the specified vSwitch.
    400InvalidGeneralGroupName.MalformedThe specified parameter GeneralGroupName is not valid.The value of the GeneralGroupName parameter is invalid.
    400AccountBasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your information is incomplete. Complete your information and try again.
    400IncorrecttVpcIdThe specified parameter VPCId is not valid.The value of the VPCId parameter is invalid. Specify a valid value.
    400OperationDenied.DBInstanceStatusOperation is denied by the current database instance status.The operation failed. The RDS instance is not in a ready state.
    400InvalidDBInstanceClass.OfflineThe specified instance type is no longer provided. Please specify another instance type.The instance type that you select is no longer available. Select another instance type.
    403ClassicNetworkType.NotSupportThe Classic instance network create is not support.The current instance cannot be deployed in the classic network. Change the network type to VPC.
    403InvalidEngineVersionInRegion.NotAvailableThe EngineVersion in the Region is not available.The database engine version is not supported in the region.
    403OperationDeniedThe specified request is out of resources.The specified request resource is insufficient.
    403QuotaExceeded.CreateInstanceThe quota of create instance exceeds.The maximum number of instances has been exceeded. Release the instances that are no longer needed.
    403Forbidden.AuthenticationThe operation is forbidden by Aliyun Realname Authentication System.-
    403INST_HAS_UNPAID_ORDERThe instanceId has unpaid order.You have an unpaid order for the instance. Pay for or cancel the order and try again.
    403COMMODITY.FAILEDThe commodity is error.A server error occurred. Contact O&M engineers.
    403MoneyLessThan100The Account Monet less Than 100.Your account balance is insufficient. Add funds to your account.
    403OperationDenied.ClassicNetworkTypeThe operation is not permitted due to status of instance.The Classic network type does not support the current operation.
    404InvalidDBInstanceId.NotFoundInvalid DBInstanceId NotFound.The RDS instance cannot be found. Check whether the RDS instance is created within the logged-on account.
    404CreateOrder.FailedCreate Order Failed.Failed to create the purchase order.
    404InvalidRegionId.NotFoundThe provided RegionId does not exist in our records.The region ID cannot be found. Check the region ID.
    404QueryPrice.FailedQueryPrice Failed.The inquiry failed. Contact Alibaba Cloud customer service representatives.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-04-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-04-06The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    2023-03-16The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404