Creates an ApsaraDB for SelectDB instance.
Operation description
Subscription instances cannot be deleted.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
selectdb:CreateDBInstance |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ResourceGroupId |
string |
No |
The ID of the resource group. |
rg-aekzt2zaluvuvqa_fake |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of this parameter on the client side. The value must be unique across different requests and can be up to 64 ASCII characters in length. The value cannot contain non-ASCII characters. |
AB |
| Engine |
string |
No |
The database engine type. Default value: selectdb. |
selectdb |
| EngineVersion |
string |
Yes |
The database engine version. Default value: 4.1. Valid values:
|
4.1 |
| ChargeType |
string |
Yes |
The billing method of the instance. Valid values:
|
PrePaid |
| UsedTime |
integer |
No |
The subscription duration of the instance. The unit is specified by the Period parameter. Year indicates years, and Month indicates months. Valid values:
Note
This parameter takes effect and is required only when ChargeType is set to Prepaid. |
1 |
| Period |
string |
No |
Specifies the billing cycle of the subscription cluster. Valid values:
Note
This parameter takes effect and is required only when ChargeType is set to Prepaid. |
Month |
| DBInstanceClass |
string |
Yes |
The instance type. You can call the DescribeAllDBInstanceClass operation to query instance types. |
selectdb.g.2xlarge |
| RegionId |
string |
Yes |
The region ID. |
cn-hangzhou |
| ZoneId |
string |
Yes |
The zone ID. |
cn-hangzhou-e |
| CacheSize |
integer |
Yes |
The reserved cache size. |
200 |
| VpcId |
string |
Yes |
The VPC ID. |
vpc-bp175iuvg8nxqraf2**** |
| VSwitchId |
string |
Yes |
The vSwitch ID. |
vsw-bp1gzt31twhlo0sa5**** |
| DBInstanceDescription |
string |
No |
The description of the instance. |
New instance test |
| ConnectionString |
string |
No |
The database endpoint. |
selectdb-cn-7213c8y****-public.selectdbfe.pre.rds.aliyuncs.com |
| SecurityIPList |
string |
No |
The IP address whitelist of the instance. Separate multiple IP addresses with commas (,). |
192.168.1.1 |
| Tag |
array<object> |
No |
The tag list information of the instance. |
|
|
object |
No |
The list of instance tags. |
||
| Key |
string |
No |
The tag key. |
testKey |
| Value |
string |
No |
The tag value. |
testValue |
| DeployScheme |
string |
No |
The deployment mode of the instance. Valid values:
|
single_az |
| MultiZone |
array<object> |
No |
The multi-zone configuration. Note
|
|
|
object |
No |
The list of zones. |
||
| VSwitchIds |
array |
No |
The list of vSwitch IDs. |
|
|
string |
No |
The vSwitch ID. |
vsw-bp10dbralpn4bzmgkkh8f |
|
| ZoneId |
string |
No |
The zone ID. |
cn-hangzhou-k |
| AddVPCIPs |
string |
No |
Specifies whether to add the VPC CIDR block to the whitelist. Valid values:
Valid values:
|
1 |
| ClusterNodeType |
string |
No |
The cluster node type. This parameter takes effect only in Serverless mode. Valid values:
|
base |
| ClusterNodeCount |
integer |
No |
The number of cluster nodes. This parameter takes effect only in Serverless mode. |
1 |
| ScaleMax |
number |
No |
The maximum value of the automatic scaling range for the RCU (RDS Capacity Unit) of the instance. |
32 |
| ScaleMin |
number |
No |
The minimum value of the automatic scaling range for the RCU (RDS Capacity Unit) of the instance. |
4 |
| ConfigPatternType |
string |
No |
The configuration template applied to the instance. Valid values:
|
normal |
| FEClassCode |
string |
No |
The node specifications of a single node in the frontend (FE) cluster. This parameter takes effect only when you create a pay-as-you-go or subscription instance. Default value: selectdb_fe.xlarge16. |
selectdb_fe.xlarge16 |
| FENodeCount |
string |
No |
The number of nodes in the FE cluster. This parameter takes effect only when you create a pay-as-you-go or subscription instance. Default value: 3. Valid values: 1 to 11. The value must be an odd number. |
3 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| Data |
object |
The returned data. |
|
| DBInstanceId |
string |
The instance ID. |
selectdb-cn-7213cjv**** |
| OrderId |
integer |
The order ID. |
21137950671**** |
| RequestId |
string |
The request ID. |
4773E4EC-025D-509F-AEA9-D53123FDFB0F |
Examples
Success response
JSON format
{
"Data": {
"DBInstanceId": "selectdb-cn-7213cjv****",
"OrderId": 0
},
"RequestId": "4773E4EC-025D-509F-AEA9-D53123FDFB0F"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | COMMODITY.INVALID_COMPONENT | Order configuration parameters do not meet the verification conditions, please re-match the product. | Order configuration parameters do not meet the verification conditions, please re-match the product! |
| 400 | DocumentConvertFailed.ExceedFileSizeLimit | The conversion has been failed, exceed file size limit. | english description1 |
| 400 | Forbidden | User not authorized to operate on the specified resource, or this API does not support RAM. | english description1 |
| 400 | InvalidDBName | The specified database name is not allowed. | english description1 |
| 400 | CreateOrderFailed | Failed to create order. | Failed to create order. |
| 400 | InvalidVSwitchId.Malformed | The specified parameter "VSwitchId" is not valid. | The parameter VSwitchId is invalid. |
| 400 | InvalidMultiZone.NotThreeZones | The number of zones must be three. | The number of multi-availability zones must be three. |
| 400 | InvalidZoneId.Duplicated | The zones cannot be repeated please select different zones. | The selected Availability Zone cannot be duplicated |
| 400 | EngineVersionDoNotSupportMultiZone | The specified engine version doesn't support multi zone. | The specified version does not support the multi_az deploy scheme. |
| 400 | InvalidChargeType.Malformed | The specified parameter "ChargeType" is not valid. | The specified parameter "ChargeType" is not valid. |
| 400 | InvalidBuyConfigCpuOrCacheSize | The specified purchase configuration CPU or cache size is invalid. | The specified purchase configuration CPU or cache size is invalid. |
| 400 | InvalidZoneId.Malformed | The specified parameter "ZoneId" is not valid. | The ZoneId parameter is invalid |
| 400 | InvalidVpcId.Malformed | The specified parameter "VpcId" is not valid. | Invalid VpcId parameter |
| 400 | ORDER.INST_HAS_UNPAID_ORDER | Instance has unpaid order. | The instance has an unpaid order. |
| 400 | OperationDenied.OrderProcessing | There are orders in process. | There are orders in process. |
| 400 | InvalidInstanceClass.MultiAZ | The instance with 4-core BE cluster does not support multi-zone redundancy. | 4-CPU BE clusters do not support multi-zone same-city redundancy. |
| 400 | InvalidFEClassCode.Blank | The specified parameter "FEClassCode" is blank. | The request parameter FEClassCode is empty. |
| 400 | InvalidFENodeCount | The specified parameter "FENodeCount" is not valid. | The FENodeCount parameter is invalid. |
| 400 | InvalidFENodeCount.Blank | The specified parameter "FENodeCount" is blank. | Request parameters |
| 400 | InvalidInstanceClass.ForMultiAZ | The instance with 4-core BE cluster does not support upgrading to multi-zone redundancy. | 4-CPU BE clusters do not support multi-zone same-city redundancy. |
| 400 | InvalidFENodeCount.ForMultiAZ | The instance with FENodeCount that less than 3 does not support upgrading to multi-zone redundancy. | The number of FE nodes of a redundant instance in the same city must be greater than or equal to 3. |
| 400 | InvalidDBClusterClass.SeriesNotSupport | Current class code is no longer available for creating instances, please use the standard series class code (e.g. selectdb.g.2xlarge). | Instance creation using the current specifications is not supported. Obtain the correct specifications through the DescribeAllDBInstanceClass interface. |
| 403 | DBClusterNotSupported | The requested operation can not be performed while the cluster is not sale. | The requested operation cannot be performed while the cluster is not running. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | english description1 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations. | english description1 |
| 403 | InvalidDBInstanceState.NotSupport | The specified instance state does't support this operation. | The instance is in a state that does not support the current operation. |
| 403 | MoneyLessThan100 | The Account Monet less Than 100. | english description1 |
| 403 | OperationDenied.DBNameAndAccountPrivilegeCount | The operation is not permitted due to count of database or account privilege. | english description1 |
| 403 | InsufficientResourceCapacity | The resource is out of usage. | Not enough resources, please try again later. |
| 403 | INSUFFICIENT_AVAILABLE_QUOTA | Your account available limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase |
| 403 | OperationDenied.SpecificClassCodeNotSupported | The uid is not in specific classcode whitelist. | The selected specification is not open to the current account. |
| 404 | DBInstanceLocked | The current instance lock mode does not support this operation. | english description1 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | english description1 |
| 404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | |
| 404 | InvalidDBInstance.NotFound | The specified instance is not found. | english description1 |
| 404 | InvalidDBInstanceClass.NotFound | The specified instance classic does not exist. | english description1 |
| 404 | InvalidRegionId.NotFound | The provided RegionId does not exist in our records. | english description1 |
| 404 | QueryPrice.Failed | The inquiry failed. Contact Alibaba Cloud customer service representatives. | english description1 |
| 404 | InvalidVSwitch.NoIP | VSwitch has zero available IP. | VSwitch has zero available IP. |
| 404 | InvalidDBClusterClass.NotFound | The specified cluster class does not exist. | The specified cluster class does not exist. |
| 404 | InvalidVPC.NotFound | VPC or VSwitch is not valid. | Invalid VPC or VSwitch |
| 404 | InvalidFEClass.NotFound | The specified fe class doesn't exist. | The FE cluster specification does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.