CreateVCUInstance - Tablestore - Alibaba Cloud Documentation Center

Creates a VCU instance.

Operation description

Before you call this operation, ensure that you understand the billing methods and pricing of Tablestore. For more information, see Billing overview.
An Alibaba Cloud account can create a maximum of 10 instances. The instance names must be unique within the same region.
The cluster type (instance type) cannot be changed after an instance is created. Select the cluster type with caution.

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

ots:CreateInstance

create

*All Resource

*

None

Request syntax

POST /v2/openapi/createvcuinstance HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
ClusterType	string	Yes	The cluster type.	SSD vs HYBRID
VCU	integer	Yes	The instance type: the number of VCUs.	1
PeriodInMonth	integer	Yes	The subscription duration. Unit: month.	1
EnableElasticVCU	boolean	No	Specifies whether to enable instance elasticity. If you enable instance elasticity, the peak VCU usage can exceed the purchased VCU amount, but additional fees are incurred.
AliasName	string	No	The alias of the instance.	test
InstanceDescription	string	No	The description of the instance.	testvcu
Tags	array<object>	No	The tags.
	object	No	The key-value pair of the tag.
Key	string	Yes	The key of the tag. The key can be up to 64 characters in length.	created
Value	string	Yes	The value of the tag. The value can be up to 64 characters in length.	0woauavextilfqr61
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxh4em5jnbcd
EnableAutoRenew	boolean	No	Specifies whether to enable auto-renewal.
AutoRenewPeriodInMonth	integer	No	The auto-renewal cycle. This parameter is required if auto-renewal is enabled.	1
DryRun	boolean	No	Specifies whether to perform a dry run. If you perform a dry run, no instance is created.	false

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The request ID.	39871ED2-62C0-578F-A32E-B88072D5582F
InstanceName	string	The name of the created instance.	instance-test
Code	string	The status code of the response.	200
Message	string	The description of the response message.	success

Examples

Success response

JSON format

{
  "RequestId": "39871ED2-62C0-578F-A32E-B88072D5582F",
  "InstanceName": "instance-test",
  "Code": "200",
  "Message": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.