DocsICP FilingConsole
Documentation

CheckCreateDBInstance

Updated at:
Copy as MD
Product
My Favorites

Performs a precheck before you create an ApsaraDB for SelectDB instance.

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:CheckCreateDBInstance

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
ResourceGroupId

string

No

The resource group ID.

rg-4690g37929****
ClientToken

string

No

The client token that is used to ensure the idempotency 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.

AB
Engine

string

No

The database engine type.

SelectDB
EngineVersion

string

Yes

The database engine version.

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 of the instance. The unit is specified by Period. Year indicates years and Month indicates months. Valid values:

  • If Period is set to Year, the valid values of UsedTime are 1, 2, 3, 4, and 5 (integers).

  • If Period is set to Month, the valid values of UsedTime are 1 to 12 (integers).

Note

This parameter takes effect and is required only when ChargeType is set to Prepaid.

1
Period

string

No

Specifies whether the upfront subscription cluster uses a yearly or monthly billing cycle. Valid values:

  • Year: yearly billing cycle.

  • Month: monthly billing cycle.

Note

This parameter takes effect and is required only when ChargeType is set to Prepaid.

Month
DBInstanceClass

string

Yes

The instance type. Valid values:

  • selectdb.xlarge: 4 cores, 32 GB memory.

  • selectdb.2xlarge: 8 cores, 64 GB memory.

  • selectdb.4xlarge: 16 cores, 128 GB memory.

  • selectdb.8xlarge: 32 cores, 256 GB memory.

  • selectdb.16xlarge: 64 cores, 512 GB memory.

  • selectdb.24xlarge: 96 cores, 768 GB memory.

  • selectdb.32xlarge: 128 cores, 1024 GB memory.

Valid values:

  • selectdb.2xlarge :

    8 cores, 64 GB memory.

  • selectdb.4xlarge :

    16 cores, 128 GB memory.

  • selectdb.24xlarge :

    96 cores, 768 GB memory.

  • selectdb.32xlarge :

    128 cores, 1024 GB memory.

  • selectdb.16xlarge :

    64 cores, 512 GB memory.

  • selectdb.xlarge :

    4 cores, 32 GB memory.

  • selectdb.8xlarge :

    32 cores, 256 GB memory.

selectdb.xlarge
RegionId

string

Yes

The region ID.

cn-hangzhou
ZoneId

string

Yes

The zone ID.

cn-hangzhou-i
CacheSize

integer

Yes

The reserved cache size. Unit: GB.

200
VpcId

string

Yes

VPC ID。

vpc-bp175iuvg8nxqraf2****
VSwitchId

string

Yes

The vSwitch ID.

vsw-bp1gzt31twhlo0sa5****
DBInstanceDescription

string

No

The description of the instance.

NewInstanceTest
ConnectionString

string

No

The endpoint of the instance.

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 (,).

172.16.XX.XX/12,192.168.XX.XX/22

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

ADF42B18-43FD-5100-83A9-BE81AB70C863

Examples

Success response

JSON format

{
  "RequestId": "ADF42B18-43FD-5100-83A9-BE81AB70C863"
}

Error codes

HTTP status code

Error code

Error message

Description
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.
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 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 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.