CreateInstances - Tair - Alibaba Cloud Documentation Center

Creates multiple ApsaraDB for Redis instances at a time.

Operation Description

Before you call this operation, make sure that you understand the billing methods and pricing of ApsaraDB for Redis.

NoteFor more information about how to create an instance that meets your requirements in the ApsaraDB for Redis console, see Step 1: Create an ApsaraDB for Redis instance.

To create an ApsaraDB for Redis Enhanced Edition (Tair) instance that uses cloud disks, call CreateTairInstance.

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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is 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	Association operation
kvstore:CreateInstances	WRITE	Redis acs:kvstore:{#regionId}:{#accountId}:instance/*	kvstore:InstanceClass	none

Request parameters

Parameter	Type	Required	Description	Example
Instances	string	Yes	The configurations of the instance in the JSON format. For more information, see Description of the Instances parameter.	[{ "RegionId": "cn-hangzhou", "izNo": "cn-hangzhou-b", "quantity": 2, "instanceType": "Redis", "instanceClass": "redis.master.small.default", "EngineVersion": "5.0", "ChargeType": "PostPaid"}]
Token	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 it is unique among different requests. The token is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCz****
AutoPay	boolean	No	Specifies whether to enable automatic payment. Default value: true. Valid values: true: yes false: no If automatic payment is disabled, you must perform the following steps to complete the payment in the ApsaraDB for Redis console: In the top navigation bar, choose Expenses > Renewal Management. In the left-side navigation pane, click Orders. On the Orders page, find the order and complete the payment. NoteThis parameter is available only if ChargeType in the Instances parameter is set to PrePaid.	true
BusinessInfo	string	No	The additional business information about the instance.	000000000
CouponNo	string	No	The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.	youhuiquan_promotion_option_id_for_blank
EngineVersion	string	No	The database engine version of the instance. Valid values: 4.0 and 5.0. NoteThe default value is 5.0.	5.0
RebuildInstance	boolean	No	Specifies whether to restore the source instance from the recycle bin. Default value: false. Valid values: true: yes false: no NoteThis parameter is available only if SrcDBInstanceId in the Instances parameter is specified.	false
AutoRenew	string	No	Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values: true: yes false: no NoteThis parameter is available only if ChargeType in the Instances parameter is set to PrePaid.	false
ResourceGroupId	string	No	The ID of the resource group to which to assign the instance.	rg-resourcegroupid1

Response parameters

Parameter	Type	Description	Example
	object
OrderId	string	The ID of the order.	20905403119****
RequestId	string	The ID of the request.	561AFBF1-BE20-44DB-9BD1-6988B53E****
InstanceIds	array	The IDs of instances that were created.
	string		r-bp16e70a4338****

Examples

Sample success responses

JSONformat

{
  "OrderId": "20905403119****",
  "RequestId": "561AFBF1-BE20-44DB-9BD1-6988B53E****",
  "InstanceIds": {
    "InstanceId": [
      "r-bp16e70a4338****"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Zone.Closed	Specified zone is closed.	-
400	MissingParameter	Period is mandatory for this action.	-
400	InvalidToken.Malformed	The Specified parameter "Token" is not valid.	An error has occurred while authenticating the token.
400	InvalidInstanceName.Malformed	The Specified parameter "InstanceName" is not valid.	The instance name is invalid.
400	InvalidPassword.Malformed	The Specified parameter "Password" is not valid.	The password is invalid.
400	InvalidInstances.Malformed	The Specified parameter "Instances" is not valid.	The Instances value is invalid.
400	InsufficientBalance	Your account does not have enough balance.	Your account balance is insufficient. Add funds to your account and try again.
400	QuotaExceed.AfterpayInstance	Living afterpay instances quota exceeded.	The maximum number of instances has been reached.
400	InvalidCapacity.NotFound	The Capacity provided does not exist in our records.	The specified instance capacity is invalid.
400	ResourceNotAvailable	Resource you requested is not available for finance user.	The requested resource is unavailable to users of Alibaba Finance Cloud.
400	PaymentMethodNotFound	No payment method has been registered on the account.	No payment methods are specified for your account.
400	IdempotentParameterMismatch	Request uses a client token in a previous request but is not identical to that request.	The current request uses a token that was already used in a different request.
400	QuotaNotEnough	Quota not enough in this zone.	The number of instances specified for this region is insufficient.
400	QuotaExceed	Living afterpay instances quota exceed.	The maximum number of instances has been reached.
400	VpcServiceError	Invoke vpc service failed.	-
400	IzNotSupportVpcError	Specify iz not support vpc.	The specified iz does not support VPCs.
400	InvalidVpcIdRegion.NotSupported	The Specified vpcId or vSwitchId not supported.	-
400	ResourceGroupNotExist	The Specified ResourceGroupId does not exist.	-
403	RealNameAuthenticationError	Your account has not passed the real-name authentication yet.	Your account has not completed real-name verification.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-02-22

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	delete Error Codes: 403
	delete Error Codes: 404