CreateDrdsInstance - PolarDB - Alibaba Cloud Documentation Center

Creates an 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

drds:CreateDrdsInstance

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Description	string	Yes	The description of the instance. The description must meet the following requirements: It cannot start with http:// or https://. It must start with a letter or a Chinese character and can contain uppercase letters, lowercase letters, Chinese characters, digits, underscores (_), or hyphens (-). It must be 2 to 256 characters in length.	test
RegionId	string	Yes	The region ID.	cn-hangzhou
ZoneId	string	Yes	The zone ID.	cn-hangzhou-e
Type	string	Yes	The instance type. Only PRIVATE is supported, which indicates a dedicated instance. Note You can also set this parameter to 1 to indicate a dedicated instance.	PRIVATE
Quantity	integer	Yes	The number of instances to create. Only the value 1 is supported, which indicates that only one instance can be created at a time.	1
InstanceSeries	string	Yes	The instance edition parameter. Valid values: drds.sn2.4c16g: Starter Edition drds.sn2.8c32g: Standard Edition drds.sn2.16c64g: Enterprise Edition.	drds.sn2.4c16g
Specification	string	Yes	The instance specification code. The value consists of the instance edition and the specific instance specification. Example: drds.sn2.4c16g.8c32g.	drds.sn2.4c16g.8C32g
ClientToken	string	Yes	The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.	c1dd299c-10c6-11ea-bbbb-************
PayType	string	Yes	The billing method. Valid values: drdsPre: subscription. drdsPost: pay-as-you-go. drdsRo: When you create a read-only instance, the pay-as-you-go billing method is used by default.	drdsPost
VpcId	string	No	The VPC ID.	vpc-**********
VswitchId	string	No	The vSwitch ID.	vsw-**********
isHa	boolean	No	Specifies whether the instance is a high-availability instance.	true
PricingCycle	string	No	Specifies the billing cycle of the subscription instance. Valid values: year: yearly subscription month: monthly subscription Note This parameter is required if PayType is set to drdsPre.	month
Duration	integer	No	The subscription duration of the instance. If PricingCycle is set to year, valid values are 1 to 3. If PricingCycle is set to month, valid values are 1 to 9. Note This parameter takes effect only when PayType is set to drdsPre.	1
IsAutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true: Auto-renewal is enabled. If the instance is purchased on a monthly basis, the instance is automatically renewed for one month. If the instance is purchased on a yearly basis, the instance is automatically renewed for one year. false: Auto-renewal is disabled. Note This parameter takes effect only when PayType is set to drdsPre.	true
MasterInstId	string	No	The instance ID of the primary instance. Specify this parameter only when you create a read-only instance.	drds***********
MySQLVersion	integer	No	The MySQL version supported by the instance. Valid values: 5: fully compatible with MySQL 5.x (default) 8: fully compatible with MySQL 8.0 Note This parameter takes effect only when you create a primary instance. The MySQL version of a read-only instance is the same as that of the primary instance by default.	5
ResourceGroupId	string	No	The resource group ID.	rg-************

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The request ID.	D99D4644-A70D-49A3-B8B4-767ACC50SE2R
Data	object	The result details.
OrderId	integer	The order ID.	111111111111111
DrdsInstanceIdList	object
drdsInstanceIdList	array	Indicates the ID of the instance.
	string	Instance ID.	drds************

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "D99D4644-A70D-49A3-B8B4-767ACC50SE2R",
  "Data": {
    "OrderId": 111111111111111,
    "DrdsInstanceIdList": {
      "drdsInstanceIdList": [
        "drds************"
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message
400	ParameterError	Parameter error
400	ActionUnauthorized	The specified action is not available for you
400	ServiceUnable	The service is not available now, please try again later
400	OperationDenied	drds service is not enable for you
400	QuotaExceeded.DRDSInstance	The quota of create instance exceeds.
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
400	InvalidDescription.MalFormed	The specified parameter description is not valid.
400	CommunicateWithManager.Error	Internal Error. Communicate with drds manager error
400	InvalidVSwitchId	Invalid vswitchId
400	InvalidVpcId	Invalid vpcId, or the region of vpc does not match
400	InvalidZoneId.Mismatch	zone is illegal in this order
400	LowInventory.ServerError	low inventory error
400	publicInstanceAlreadExist.Error	a public Drds instance is exist
400	CreateDRDSInstanceId.Error	create Drds instance id error
400	ResourceInsufficient	resource is Insufficient
400	AnotherOrderExist.Error	there is another order
400	InstanceExceedLimit.Error	instance number has exceeded
400	InvalidParameter.Quantity	Invalid parameter of quantity
400	InvalidParameter.RegionId	Invalid parameter of region id
400	InvalidParameter.ZoneId	Invalid parameter of zone id
400	InvalidParameter.PayType	Invalid parameter of pay type
400	InvalidParameter.Spection	Invalid parameter of specification
400	InvalidParameter.Series	Invalid parameter of series
400	InvalidParameter.duration_pricingCycle	when payType=drdsPre, duration and pricingCycle is required
400	InvalidParameter.year.duration	when pricingCycle=year, duration must between 1 to 3
400	InvalidParameter.month.duration	when pricingCycle=month, duration must between 1 to 9
400	InvalidDRDSInstanceType.Error	Invalid parameter of Type, public is not supported
400	QueryVSwitchFailed.InvalidVpcIdOrServerError	Query VSwitch failed, please check vpcId
400	RegionNotSupportVPC.Error	This region does not support vpc instance
400	UserAccountVerify.Failed	User account verify failed. Please verify first
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.