All Products
Search
Document Center

Tair (Redis® OSS-Compatible):CreateTairKVCacheVNode

Last Updated:Nov 27, 2025

Creates a Tair VNode instance.

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

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:CreateTairKVCacheVNodecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the instance resides.

cn-beijing
ZoneIdstringYes

The zone ID of the instance.

cn-beijing-f
InstanceNamestringNo

The name of the instance. The name must be 2 to 80 characters in length. The name must start with a letter and cannot contain spaces or the following special characters: @ / : = " < > { [ ] }

vnodetest
InstanceClassstringYes

Instance specification

kvcache.cu.g4b.2
ComputeUnitNumintegerYes

The number of compute units. Valid values: 1.

1
VkNamestringYes

The ID of the VCluster that contains the VNode.

tk-2ze4bba3c8fe****
VSwitchIdstringYes

The ID of the vSwitch to which the instance belongs. The vSwitch must belong to the VPC of the VCluser. You can call the DescribeVpcs operation to query the VPC ID.

Note The vSwitch and the instance must be deployed in the same zone.
vsw-bp1e7clcw529l773d****
ChargeTypestringNo

The new billing method. Valid values:

  • PrePaid: subscription. If you set this parameter to PrePaid, you must also specify the Period parameter.
PrePaid
PeriodintegerNo

The subscription duration. Valid values: 1 to 9, 12, 24, and 36. Unit: months.

Note This parameter is required only if the ChargeType parameter is set to PrePaid.
1
BusinessInfostringNo

The extended information such as the promotional event ID and business information.

000000000
CouponNostringNo

The coupon code.

youhuiquan_promotion_option_id_for_blank
AutoUseCouponbooleanNo

Specifies whether to use a coupon. Valid values:

  • true: uses a coupon.
  • false: does not use a coupon.
false
AutoRenewbooleanNo

Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values:

  • true: enabled
  • false: disables auto-renewal.
false
AutoRenewPeriodstringNo

The subscription duration that is supported by auto-renewal. Unit: month. Valid values: 1, 2, 3, 6, and 12.

Note This parameter is required if the AutoRenew parameter is set to true.
1
ResourceGroupIdstringNo

The ID of the resource group that you want to manage.

Note
rg-acfmyiu4ekp****
AutoPaybooleanNo

Specifies whether to enable automatic payment. Set the value to true.

true
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests and is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCz****
Tagarray<object>No

Details of the tags.

objectNo

Details of the tag.

ValuestringNo

The value of tag N of the instance.

Note N specifies the value of the nth tag. For example, Tag.1.Value specifies the value of the first tag, and Tag.2.Value specifies the value of the second tag.
key1_test
KeystringNo

The tag key.

Note A maximum of five key-value pairs can be specified at a time.
value1_test
DryRunbooleanNo

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run and does not create the instance. The system prechecks the request parameters, request format, service limits, and available resources. If the request fails to pass the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: performs a dry run and performs the actual request. If the request passes the dry run, the instance is created.
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

2BE6E619-A657-42E3-AD2D-18F8428A****
InstanceIdstring

The ID of the Tair VNode instance.

tv-2zeb1ce76fee****
OrderIdlong

The order ID.

20905403119****
RegionIdstring

The ID of the region where the instance resides.

cn-beijing
ZoneIdstring

The zone ID of the instance.

cn-beijing-f
VkNamestring

The ID of the VCluster instance.

tk-2ze4bba3c8fe****
VClusterIdstring

The ID of the VCluster.

vc-16965a9267*****-*****
NodeIdstring

The ID of the VNode.

vn-03a49876edb****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400MissingParameterPeriod is mandatory for this action.-
400InvalidToken.MalformedThe Specified parameter Token is not valid.-
400InvalidInstanceName.MalformedThe Specified parameter InstanceName is not valid.-
400InvalidPassword.MalformedThe Specified parameter Password is not valid.-
400InsufficientBalanceYour account does not have enough balance.Your account balance is insufficient. Add funds to your account and try again.
400QuotaExceed.AfterpayInstanceLiving afterpay instances quota exceeded.The maximum number of instances has been reached.
400InvalidCapacity.NotFoundThe Capacity provided does not exist in our records.The specified storage specification does not exist.
400ResourceNotAvailableResource you requested is not available for finance user.The requested resource is unavailable to users of Alibaba Finance Cloud.
400PaymentMethodNotFoundNo payment method has been registered on the account.No payment methods are specified for your account.
400IdempotentParameterMismatchRequest uses a client token in a previous request but is not identical to that request.Idempotent check.
400QuotaNotEnoughQuota not enough in this zone.The number of instances specified for this region is insufficient.
400QuotaExceedLiving afterpay instances quota exceed.The maximum number of instances has been reached.
400VpcServiceErrorInvoke vpc service failed.-
400IzNotSupportVpcErrorSpecify iz not support vpc.The specified iz does not support VPCs.
400InvalidvSwitchIdThe vpc does not cover the vswitch.-
400InvalidIzNo.NotSupportedThe Specified vpc zone not supported.-
400InvalidAccountPassword.FormatSpecified account password is not valid.-
400InstanceClass.NotMatchCurrent instance class and instance type is not match.-
400InvalidVPCId.NotFoundSpecified virtual vpc is not found.The specified VPC is not found. Check whether the VPC ID is correct.
400AccountMoneyValidateErrorAccount money validate error.-
400RequestTokenConflictSpecified request token conflict.-
400InvalidIPNotInSubnetError ip not in subnet.-
400InvalidEngineVersion.MalformedSpecified engine version is not valid.The error message returned because the instance engine version is invalid.
400Zone.ClosedThe specified zone is closed.-
400VSwithNotBelongToNotVpcFaultThe vSwitch does not belong to current vpc.-
400PayIllegalAgreementPay mayi with holding agreement illegal.-
400IllegalParamErrorvalidateSaleConditionWithSubArticle failed.-
400InvalidRegion.FormatSpecified Region is not valid.The specified region is invalid.
403RealNameAuthenticationErrorYour account has not passed the real-name authentication yet.Your account has not completed real-name verification.
403AuthorizationFailureThe request processing has failed due to authorization failure.-
403TokenServiceErrorThe specified token is duplicated, please change it.-
403UserCannotBuyNotInnerCommodityThe user can not buy this commodity without alibaba group tag.-
404InvalidvSwitchIdThe Specified vSwitchId zone not supported.The specified vswitch is not supported in this Availability Zone
404InvalidVpcIdOrVswitchId.NotSupportedThe Specified vpcId or vSwitchId not supported.-

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