All Products
Search
Document Center

Tablestore:CreateInstance

Last Updated:Nov 14, 2024

Creates an instance.

Operation description

  • Before you call this operation, you must understand the billing and pricing of Tablestore. For more information, see Billing overview.
  • Each Alibaba Cloud account can create up to 10 instances. The name of an instance must be unique within the region in which the instance resides.
  • After you create an instance, you cannot change the type of the instance. Proceed with caution.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /v2/openapi/createinstance HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body.

InstanceNamestringYes

The name of the instance. Instance naming conventions:

  • The name can contain only letters, digits, and hyphens (-).
  • The name must start with a letter.
  • The name cannot end with a hyphen (-).
  • The name is case-insensitive.
  • The name must be 3 to 16 characters in length.
  • The name cannot contain the following words: ali, ay, ots, taobao, and admin.
instance-test
ClusterTypestringYes

The type of the instance.

  • SSD: high-performance instance
  • HYBRID: capacity instance
SSD
InstanceDescriptionstringNo

The description of the instance. The instance description must be 3 to 256 characters in length.

the test instance
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs.

rg-acfmxh4em5jnbcd
NetworkstringNo

(Deprecated) The network type of the instance. Valid values: NORMAL and VPC_CONSOLE. Default value: NORMAL.

NORMAL
NetworkTypeACLarrayNo

The types of the network from which access is allowed. By default, the following network types are allowed:

  • INTERNET: Internet
  • VPC: virtual private cloud (VPC)
  • CLASSIC: classic network
stringNo

The type of the network from which access is allowed.

Valid values:

  • INTERNET: Internet
  • VPC: VPC
  • CLASSIC: classic network
VPC
NetworkSourceACLarrayNo

The types of the source from which access is allowed. By default, the following source type is allowed:

TRUST_PROXY: console

stringNo

The type of the source from which access is allowed.

Valid value:

  • TRUST_PROXY: console
TRUST_PROXY
PolicystringNo

The instance policy in the JSON format.

{ "Version": "1", "Statement": [ { "Action": [ "ots:*" ], "Resource": [ "acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*" ], "Principal": [ "*" ], "Effect": "Allow", "Condition": { "StringEquals": { "ots:TLSVersion": [ "1.2" ] }, "IpAddress": { "acs:SourceIp": [ "192.168.0.1", "198.51.100.1" ] } } } ] }
Tagsarray<object>No

The tags.

objectNo

The tag.

KeystringYes

The tag key. The tag key can be up to 64 characters in length.

p_instance
ValuestringYes

The tag value. The tag value can be up to 64 characters in length.

0woauavextilfqr61
DisableReplicationbooleanNo

(Deprecated) Specifies whether to enable disaster recovery for the instance.

Valid values:

  • false
  • true
false

Response parameters

ParameterTypeDescriptionExample
object

The returned struct.

RequestIdstring

The request ID, which can be used to troubleshoot issues.

39871ED2-62C0-578F-A32E-B88072D5582F
Codestring

The HTTP status code.

200
Messagestring

The response message.

success

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-03-21The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-10-13The response structure of the API has changedView Change Details
2023-08-16The internal configuration of the API is changed, but the call is not affectedView Change Details