DescribeTairKVCacheInferInstances - Tair (Redis® OSS-Compatible)

Queries the information of one or more Tair (Redis OSS-compatible) KVCache instances.

Operation description

You can call this operation to query the following Tair (Redis OSS-compatible) KVCache instances: inference operator instances, virtual cluster instances, and cache service instances.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeTairKVCacheInferInstances	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance resides.	cn-beijing
InstanceIds	string	No	The IDs of the instances that you want to query. Note If you want to specify multiple instance IDs, separate the instance IDs with commas (,). You can specify a maximum of 30 instance IDs in a single request.	tk-2zefe7728c2c****
InstanceStatus	string	No	The state of the instance. Valid values: Normal: The instance is normal. Creating: The instance is being created. Note For more information about instance states, see Instance states and impacts.	Normal
ChargeType	string	No	The billing method of the simple application servers. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	PrePaid
NetworkType	string	No	The network type of the instance. Default value: VPC. Valid values: VPC (default) Valid values: CLASSIC VPC	VPC
InstanceClass	string	No	The instance type.	kvcache.cu.g4c.2
VpcId	string	No	The ID of the VPC.	vpc-bp1nme44gek34slfc****
VSwitchId	string	No	The ID of the vSwitch.	vsw-bp1e7clcw529l773d****
PageNumber	integer	No	The page number of the instance list. Start value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 30.	30
SearchKey	string	No	The keyword that you want to use for fuzzy match. The keyword can be a part of an instance name or an instance ID.	apitest
Expired	string	No	Specifies whether the instance has expired. Valid values: true: The instance has expired. false: The instance has not expired.	false
ZoneId	string	No	The zone ID.	cn-hangzhou-e
ResourceGroupId	string	No	The resource group ID. You can leave this parameter empty.	rg-acfmyiu4ekp****
Tag	array<object>	No	Details of the tags.
	object	No	Details of the tag.
Key	string	No	The tag key. Note A maximum of five key-value pairs can be specified at a time.	key1_test
Value	string	No	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.	testvalue
PrivateIp	string	No	The private IP address of the instance. This parameter is deprecated.	172.16.49.***

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	CD225838-7069-5CE4-89E1-67B83AC149C8
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	30
TotalCount	integer	The total number of returned records.	3
Instances	array<object>	The information about the returned Tair (Redis OSS-compatible) KVCache instance.
TairInferInstanceDTO	object
VpcId	string	The VPC ID of the instance.	vpc-2zef5w848p4j5g***
CreateTime	string	The creation time of the instance.	2025-04-07T04:46Z
ChargeType	string	The billing method of the instance.	PostPaid
NetworkType	string	The network type of the instance.	VPC
InstanceName	string	The instance name.	kvcache-7
InstanceClass	string	The instance type.	kvcache.cu.g4b.2
DestroyTime	string	The time when the instance was deleted.	2025-04-07T04:46Z
InstanceId	string	The ID of the instance.	tk-9dp7e37bab*****
InstanceType	string	The type of the instance. Valid values: TairInfer: the inference operator instance TairKVCacheVnode: the virtual cluster instance. TairKVCacheService: the cache service instance.	TairInfer
RegionId	string	The region ID of the instance.	cn-beijing
EndTime	string	The time when the subscription instance expires.	2025-11-04T02:09:26Z
VSwitchId	string	The vSwitch ID.	vsw-8vbf0ksk774ai6q1d****
ResourceGroupId	string	The resource group ID.	rg-acfm4bdru5z****
ZoneId	string	The zone ID.	cn-hangzhou-g
InstanceStatus	string	The instance state. Valid values: Normal: The instance is normal. Creating: The instance is being created.	Normal
Tags	array<object>	Details of the tags.
Tag	object	Details of the tag.
Key	string	The tag key.	thread
Value	string	The tag value.	900
PrivateIp	string	The private IP address of the instance. This parameter is deprecated.	172.16.49.***
Capacity	long	The capacity of the KVCache. Unit: GB.	256
Model	string	The built-in model of the inference operator instance.	DeepSeek-OCR
ModelServiceNum	integer	The number of model services of the inference operator instance.	1
ComputeUnitNum	integer	The number of compute units.	1
VNodeName	string	The list of vNode instance names under the virtual cluster instance. This parameter is deprecated.	tv-xxxxx
AckId	string	The ACK cluster ID corresponding to the virtual cluster instance.	c809******************************
VNodeCount	integer	The number of vNodes in the virtual cluster.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "CD225838-7069-5CE4-89E1-67B83AC149C8",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 3,
  "Instances": {
    "TairInferInstanceDTO": [
      {
        "VpcId": "vpc-2zef5w848p4j5g***",
        "CreateTime": "2025-04-07T04:46Z",
        "ChargeType": "PostPaid",
        "NetworkType": "VPC",
        "InstanceName": "kvcache-7",
        "InstanceClass": "kvcache.cu.g4b.2",
        "DestroyTime": "2025-04-07T04:46Z\n",
        "InstanceId": "tk-9dp7e37bab*****",
        "InstanceType": "TairInfer",
        "RegionId": "cn-beijing",
        "EndTime": "2025-11-04T02:09:26Z",
        "VSwitchId": "vsw-8vbf0ksk774ai6q1d****",
        "ResourceGroupId": "rg-acfm4bdru5z****",
        "ZoneId": "cn-hangzhou-g",
        "InstanceStatus": "Normal",
        "Tags": {
          "Tag": [
            {
              "Key": "thread",
              "Value": 900
            }
          ]
        },
        "PrivateIp": "172.16.49.***",
        "Capacity": 256,
        "Model": "DeepSeek-OCR",
        "ModelServiceNum": 1,
        "ComputeUnitNum": 1,
        "VNodeName": "tv-xxxxx",
        "AckId": "c809******************************",
        "VNodeCount": 2,
        "FixedVNodeCount": 0,
        "ElasticVNodeCount": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

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

Change history

Change time	Summary of changes	Operation
2025-12-04	The Error code has changed. The response structure of the API has changed	View Change Details
2025-11-27	Add Operation	View Change Details