Deploy a Tair VNode Instance with API Step by Step - Tair - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Create a Tair VNode 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

kvstore:CreateTairKVCacheVNode

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where you want to create the instance.	cn-beijing
ZoneId	string	Yes	The ID of the zone where you want to create the instance.	cn-beijing-f
InstanceName	string	No	The name of the new instance. The name must be 2 to 80 characters long and must start with a letter (case-insensitive) or a Chinese character. Spaces and the following special characters are not supported: `@/:=”<>{[]}`.	vnodetest
InstanceClass	string	Yes	The instance specification.	kvcache.cu.g4b.2
ComputeUnitNum	integer	Yes	The number of compute units. Currently, only one compute unit is supported. Valid values: 1 : 1	1
VkName	string	Yes	The ID of the virtual cluster that hosts the VNode.	tk-2ze4bba3c8fe****
VSwitchId	string	Yes	The ID of the vSwitch for the instance. The vSwitch must belong to the VPC that is associated with the specified virtual cluster. You can call the DescribeVpcs operation to obtain the vSwitch ID. Note The vSwitch must be in the same zone as the instance.	vsw-bp1e7clcw529l773d****
ChargeType	string	No	The billing method for the instance. Valid value: PrePaid: Subscription. If you specify this value, you must also specify the Period parameter. Valid values: PrePaid : PrePaid	PrePaid
Period	integer	No	The subscription period in months. Valid values: 1 to 9, 12, 24, and 36. Note This parameter is required when the ChargeType parameter is set to PrePaid.	1
BusinessInfo	string	No	Additional business information, such as a promotion ID.	000000000
CouponNo	string	No	The coupon code.	youhuiquan_promotion_option_id_for_blank
AutoUseCoupon	boolean	No	Specifies whether to use a coupon. Valid values: true: Use a coupon. false (default): Do not use a coupon.	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true: Enables auto-renewal. false (default): Disables auto-renewal.	false
AutoRenewPeriod	string	No	The auto-renewal period, in months. Valid values: 1, 2, 3, 6, and 12. Note This parameter is required when the AutoRenew parameter is set to true.	1
ResourceGroupId	string	No	The ID of the resource group to which the instance will belong. Note You can call the ListResourceGroups operation or view resource group IDs in the console. For more information, see View the basic information about a resource group. Before changing the resource group of an instance, call the ListResources API to view the current resource group of the instance.	rg-acfmyiu4ekp****
AutoPay	boolean	No	Specifies whether to automatically complete the payment. The value must be true.	true
ClientToken	string	No	A client-generated token that ensures request idempotence. This token must be unique across requests, is case-sensitive, and cannot exceed 64 ASCII characters.	ETnLKlblzczshOTUbOCz****
Tag	array<object>	No	The tags to add to the instance. You can specify a maximum of five tags.
	object	No
Key	string	No	The tag key. Note You can specify up to 5 tag key-value pairs at a time.	value1_test
Value	string	No	The tag value. Note N represents the index of a tag, starting from 1. For example, Tag.1.Value is the value of the first tag.	key1_test
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run and does not create the instance. The system checks the request parameters, request format, business limits, and available inventory. If the check fails, the system returns the corresponding error. If the check passes, the system returns the `DryRunOperation` error code. false (default): Sends a normal request. If the check passes, the system creates the instance.	false
VNodeType	string	No	This parameter is no longer used.
ElasticTimeRange	string	No	This parameter is no longer used.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2BE6E619-A657-42E3-AD2D-18F8428A****
InstanceId	string	The instance ID of the virtual node.	tv-2zeb1ce76fee****
OrderId	integer	The order ID.	20905403119****
RegionId	string	The region ID.	cn-beijing
ZoneId	string	The zone ID.	cn-beijing-f
VkName	string	The instance ID of the virtual cluster.	tk-2ze4bba3c8fe****
VClusterId	string	The ID of the virtual cluster.	vc-16965a9267***-***
NodeId	string	The ID of the virtual node.	vn-03a49876edb****

Examples

Success response

JSON format

{
  "RequestId": "2BE6E619-A657-42E3-AD2D-18F8428A****",
  "InstanceId": "tv-2zeb1ce76fee****",
  "OrderId": 0,
  "RegionId": "cn-beijing",
  "ZoneId": "cn-beijing-f",
  "VkName": "tk-2ze4bba3c8fe****\n",
  "VClusterId": "vc-16965a9267*****-*****",
  "NodeId": "vn-03a49876edb****"
}

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	InsufficientBalance	Your account does not have enough balance.
400	QuotaExceed.AfterpayInstance	Living afterpay instances quota exceeded.
400	InvalidCapacity.NotFound	The Capacity provided does not exist in our records.
400	ResourceNotAvailable	Resource you requested is not available for finance user.
400	PaymentMethodNotFound	No payment method has been registered on the account.
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	AccountMoneyValidateError	Account money validate error.
400	RequestTokenConflict	Specified request token conflict.
400	InvalidIPNotInSubnet	Error ip not in subnet.
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	VSwithNotBelongToNotVpcFault	The vSwitch does not belong to current vpc.
400	PayIllegalAgreement	Pay mayi with holding agreement illegal.
400	IllegalParamError	validateSaleConditionWithSubArticle failed.
400	InvalidRegion.Format	Specified Region is not valid.	The specified region is invalid.
403	RealNameAuthenticationError	Your account has not passed the real-name authentication yet.
403	AuthorizationFailure	The request processing has failed due to authorization failure.
403	TokenServiceError	The specified token is duplicated, please change it.
403	UserCannotBuyNotInnerCommodity	The user can not buy this commodity without alibaba group tag.
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.