CreateDBInstance - ApsaraDB for SelectDB - Alibaba Cloud Documentation Center

Creates an ApsaraDB for SelectDB instance.

Operation description

You cannot delete subscription instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

selectdb:CreateDBInstance

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The resource group ID.	rg-aekzt2zaluvuvqa_fake
ClientToken	string	No	Ensures the idempotence of the request and prevents duplicate submissions. The client generates this parameter value. Ensure its uniqueness across different requests. The maximum length is 64 ASCII characters, and it cannot contain non-ASCII characters.	AB
Engine	string	No	The database type. The default value is selectdb.	selectdb
EngineVersion	string	Yes	The database version. The default value is 3.0.	3.0
ChargeType	string	Yes	The billing method of the instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	PrePaid
UsedTime	integer	No	The subscription duration for a subscription instance. Valid values: If Period is set to Year, UsedTime can be 1, 2, 3, 4, or 5 (integers). If Period is set to Month, UsedTime can be 1 to 12 (integers). Note This parameter is valid and required only when ChargeType is set to Prepaid.	1
Period	string	No	The billing cycle for a subscription cluster. Valid values: Year: billed annually. Month: billed monthly. Note This parameter is valid and required only when ChargeType is set to Prepaid.	Month
DBInstanceClass	string	Yes	The instance type. For more information, see DescribeAllDBInstanceClass 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 VPC ID.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	Yes	The vSwitch ID.	vsw-bp1gzt31twhlo0sa5****
DBInstanceDescription	string	No	The instance description.	新建实例测试
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 list of instance tags.
	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 instance deployment mode.	single_az
MultiZone	array<object>	No	The multi-zone configuration. Note This parameter is valid and required only when DeployScheme is set to multi_az.
	object	No	The list of multi-zones.
ZoneId	string	No	The zone ID.	cn-hangzhou-k
VSwitchIds	array	No	The list of vSwitch IDs.
	string	No	The vSwitch ID.	vsw-bp10dbralpn4bzmgkkh8f
AddVPCIPs	string	No	Specifies whether to add the VPC CIDR block to the whitelist. Valid values: 1: Yes 0: No	1
ClusterNodeType	string	No
ClusterNodeCount	integer	No
ScaleMax	number	No
ScaleMin	number	No
ConfigPatternType	string	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	4773E4EC-025D-509F-AEA9-D53123FDFB0F
Data	object	The returned result.
DBInstanceId	string	The instance ID.	selectdb-cn-7213cjv****
OrderId	integer	The order ID.	21137950671****

Examples

Success response

JSON format

{
  "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.
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.
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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.