Creates an ApsaraDB for SelectDB instance.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| selectdb:CreateDBInstance | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ResourceGroupId | string | No | The resource group ID. | rg-aekzt2zaluvuvqa_fake |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, 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. | AB |
| Engine | string | No | The database engine of the instance. Default value: selectdb. | selectdb |
| EngineVersion | string | Yes | The database engine version of the instance. Default value: 3.0. | 2.4 |
| ChargeType | string | Yes | The billing method of the instance. Valid values:
| PrePaid |
| UsedTime | integer | No | The subscription duration of the instance. Valid values:
Note
This parameter takes effect and is required only when ChargeType is set to Prepaid.
| 1 |
| Period | string | No | The unit of the subscription duration of the 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.xlarge |
| RegionId | string | Yes | The region ID. | cn-hangzhou |
| ZoneId | string | Yes | The zone ID. | cn-hangzhou-e |
| CacheSize | integer | Yes | The reserved cache size. | 200GB |
| VpcId | string | Yes | The virtual private cloud (VPC) ID. | vpc-bp175iuvg8nxqraf2**** |
| VSwitchId | string | Yes | The vSwitch ID. | vsw-bp1gzt31twhlo0sa5**** |
| DBInstanceDescription | string | No | The instance description. | The instance is created for testing. |
| ConnectionString | string | No | The instance endpoint. | selectdb-cn-7213c8y****-public.selectdbfe.pre.rds.aliyuncs.com |
| SecurityIPList | string | No | The IP addresses in the whitelist of the instance. Separate multiple IP addresses with commas (,). | 192.168.1.1 |
| Tag | array<object> | No | The instance tags. | |
| object | No | The details of the instance tag. | ||
| Key | string | No | The tag key. | testKey |
| Value | string | No | The tag value. | testValue |
| DeployScheme | string | No | The deployment method of the instance. Valid values:
| single_az |
| MultiZone | array<object> | No | The configurations of multi-zone deployment. Note
| |
| object | No | The zones. | ||
| ZoneId | string | No | The zone ID. | cn-hangzhou-k |
| VSwitchIds | array | No | The vSwitch IDs. | |
| string | No | The vSwitch ID. | vsw-bp10dbralpn4bzmgkkh8f | |
| AddVPCIPs | string | No | Specifies whether to add the virtual private cloud (VPC) CIDR block to the IP address whitelist. Valid values:
| 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "4773E4EC-025D-509F-AEA9-D53123FDFB0F",
"Data": {
"DBInstanceId": "selectdb-cn-7213cjv****",
"OrderId": 0
}
}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. |
| 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. |
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-08-12 | The Error code has changed | View Change Details |
| 2024-06-12 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-12-27 | The Error code has changed. The request parameters of the API has changed | View Change Details |