CreateTairSkvDdbWorkspace - - Alibaba Cloud Documentation Center

Activates a Tair Serverless KV workspace instance.

Operation description

Before you call this operation, make sure that you understand the billing rules and pricing of ApsaraDB for Redis.
To create a Tair Serverless KV table instance, call the CreateTairSkvDdbTable operation.

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

kvstore:CreateTairSkvDdbWorkspace

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	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 the token is unique among different requests. The token is case-sensitive and can contain up to 64 ASCII characters.	ETnLKlblzczshOTUbOCz**
RegionId	string	Yes	The region ID. You can call DescribeRegions to query available regions. Use this parameter to specify the region in which to create the instance.	cn-hangzhou
ZoneId	string	Yes	The zone ID. You can call DescribeZones to query available zones.	cn-hangzhou-e
InstanceType	string	Yes	The instance type. Set the value to tair_skv_ddb_ws.	tair_skv_ddb_ws
InstanceName	string	No	The instance name. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. The name cannot contain the following characters: @ / : = " < > { } or spaces.	apitest
Password	string	No	The password of the instance. The password must meet the following requirements: The password is 8 to 32 characters in length. The password contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters are `!@#$%^&*()_+-=`.	Pass!123456
VpcId	string	Yes	The ID of the virtual private cloud (VPC).	vpc-bp1nme44gek34slfc**
VSwitchId	string	Yes	The ID of the vSwitch.	vsw-bp1e7clcw529l773d**
Port	integer	No	The service port of the instance. Valid values: 1 to 65535. Default value: 443.	443
ResourceGroupId	string	No	The resource group ID.	rg-resourcegroupid1

https://r-kvstore.aliyuncs.com/?Action=CreateInstance &RegionId=ap-southeast-1 &ZoneId=ap-southeast-1e &InstanceType=tair_skv_ddb_ws &InstanceName=apitest &

Response elements

Element	Type	Description	Example
	object	Schema of Response
QPS	integer	The queries per second (QPS). This value is the theoretical value for the current instance specifications.	100000
ConnectionDomain	string	The internal endpoint of the Redis instance.	r-bp1zxszhcgatnx**.redis.rds.aliyuncs.com
ChargeType	string	The billing method. Valid values: `PrePaid`: subscription. `PostPaid`: pay-as-you-go.	PostPaid
InstanceId	string	The globally unique instance ID.	r-bp1zxszhcgatnx**
Port	integer	The Redis service port.	443
Config	string	The detailed configuration of the instance.	{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}
RegionId	string	The region in which the instance resides.	cn-hongkong
RequestId	string	The request ID.	5DEA3CC9-F81D-4387-8E97-CEA40F09****
Bandwidth	integer	The bandwidth limit of the instance. Unit: MB/s.	96
Connections	integer	The maximum number of connections supported by the instance.	10000
InstanceName	string	The instance name.	apitest
ZoneId	string	The zone ID of the instance.	cn-hangzhou-b
InstanceStatus	string	The current status of the instance. The return value is fixed as Creating.	Creating
TaskId	string	The ID of the task flow that is executed for the creation.	1111
OrderId	integer	The order ID.	20741011111111

{ "Connections": 0, "RequestId": "3631EF6F-2979-1C04-BDAA-51XXXXXXXXX", "InstanceId": "tt-2zesmjzrj0wzncb9y", "Port": 443, "OrderId": 0, "ConnectionDomain": "tt-2zesmjzrj0wzncb9y.tairskvddb.pre.rds.aliyuncs.com", "InstanceName": "apitest", "QPS": 0, "ChargeType": "PostPaid", "InstanceStatus": "Normal", "Bandwidth": 0, "RegionId": "cn-beijing" }

Examples

Success response

JSON format

{
  "QPS": 100000,
  "ConnectionDomain": "r-bp1zxszhcgatnx**.redis.rds.aliyuncs.com",
  "ChargeType": "PostPaid",
  "InstanceId": "r-bp1zxszhcgatnx**",
  "Port": 443,
  "Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
  "RegionId": "cn-hongkong",
  "RequestId": "5DEA3CC9-F81D-4387-8E97-CEA40F09****",
  "Bandwidth": 96,
  "Connections": 10000,
  "InstanceName": "apitest",
  "ZoneId": "cn-hangzhou-b",
  "InstanceStatus": "Creating",
  "TaskId": "1111",
  "OrderId": 20741011111111
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	Period is mandatory for this action.
400	InvalidToken.Malformed	The Specified parameter Token is not valid.
400	InvalidInstanceName.Malformed	The Specified parameter InstanceName is not valid.
400	InvalidPassword.Malformed	The Specified parameter Password is not valid.
400	IdempotentParameterMismatch	Request uses a client token in a previous request but is not identical to that request.	Idempotent check.
400	QuotaNotEnough	Quota not enough in this zone.
400	QuotaExceed	Living afterpay instances quota exceed.
400	VpcServiceError	Invoke vpc service failed.
400	IzNotSupportVpcError	Specify iz not support vpc.
400	InvalidvSwitchId	The vpc does not cover the vswitch.
400	InvalidIzNo.NotSupported	The Specified vpc zone not supported.
400	InvalidAccountPassword.Format	Specified account password is not valid.
400	InstanceClass.NotMatch	Current instance class and instance type is not match.
400	InvalidVPCId.NotFound	Specified virtual vpc is not found.	The specified VPC is not found. Check whether the VPC ID is correct.
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.	The error message returned because the instance engine version is invalid.
400	Zone.Closed	The specified zone is closed.
400	InvalidRegion.Format	Specified Region is not valid.	The specified region is invalid.
403	AuthorizationFailure	The request processing has failed due to authorization failure.
403	TokenServiceError	The specified token is duplicated, please change it.
404	InvalidCapacity.NotFound	The Capacity provided does not exist in our records.	The specified storage specification does not exist.
404	InvalidvSwitchId	The Specified vSwitchId zone not supported.
404	InvalidVpcIdOrVswitchId.NotSupported	The Specified vpcId or vSwitchId not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.