DescribeTairKVCacheInferInstances API Reference - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Describes one or more Tair KVCache instances.

Operation description

Use this API to query inference operator instances, virtual cluster instances, and cache service instances for Tair KVCache.

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:DescribeTairKVCacheInferInstances

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-beijing
InstanceIds	string	No	The IDs of the instances to query. Note To specify multiple instance IDs, separate them with commas. You can specify up to 30 instance IDs per request.	tk-2zefe7728c2c****
InstanceStatus	string	No	The instance status. Valid values: Normal: The instance is running normally. Creating: The instance is being created. Note For more information about instance statuses and their impacts, see Instance Statuses and Impacts.	Normal
ChargeType	string	No	The billing method of the instance. Valid values: PrePaid: The subscription billing method. PostPaid: The pay-as-you-go billing method.	PrePaid
NetworkType	string	No	The network type of the instance. Valid values: VPC: The instance is deployed in a VPC. This is the default value.	VPC
InstanceClass	string	No	The instance type.	kvcache.cu.g4c.2
VpcId	string	No	The VPC ID.	vpc-bp1nme44gek34slfc****
VSwitchId	string	No	The VSwitch ID.	vsw-bp1e7clcw529l773d****
PageNumber	integer	No	The page number to return. Pages are numbered starting from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 30.	30
SearchKey	string	No	A keyword for a fuzzy search on the instance name or instance ID.	apitest
Expired	string	No	The expiration status of the instance. 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	The tags used to filter instances.
	object	No	实例的标签信息。
Key	string	No	The key of the tag. A tag is a key-value pair. Note You can specify up to five tag key-value pairs per request.	key1_test
Value	string	No	The value of the tag. Note The N in a parameter name such as Tag.N.Value represents the tag number. 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. This parameter is deprecated.	172.16.49.***

Response elements

Element	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 entries.	3
Instances	object	Details of the Tair KVCache instances.
TairInferInstanceDTO	array<object>	Tair KVCache instance information.
	array<object>
VpcId	string	The VPC ID.	vpc-2zef5w848p4j5g***
CreateTime	string	The time when the instance was created.	2025-04-07T04:46Z
ChargeType	string	The billing method.	PostPaid
NetworkType	string	The network type.	VPC
InstanceName	string	The instance name.	kvcache-7
InstanceClass	string	The instance type.	kvcache.cu.g4b.2
DestroyTime	string	The time when the instance is scheduled to be destroyed.	2025-04-07T04:46Z
InstanceId	string	The instance ID.	tk-9dp7e37bab*****
InstanceType	string	The instance type. Valid values: TairInfer: A TairInfer instance. TairKVCacheVnode: A virtual cluster instance. TairKVCacheService: A cache service instance.	TairInfer
RegionId	string	The region ID.	cn-beijing
EndTime	string	The expiration time of the subscription instance.	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 status. Valid values: Normal: The instance is running. Creating: The instance is being created.	Normal
Tags	object	The tags of the instance.
Tag	array<object>	The tag information of the instance.
	object	The details of the tag.
Key	string	The key of the tag.	thread
Value	string	The value of the tag.	900
PrivateIp	string	The private IP address. This parameter is deprecated.	172.16.49.***
Capacity	integer	The storage capacity of the KVCache instance. Unit: GB.	256
Model	string	The built-in model of the TairInfer instance.	DeepSeek-OCR
ModelServiceNum	integer	The number of model services in the TairInfer instance.	1
ComputeUnitNum	integer	The number of compute units.	1
VNodeName	string	The names of vNode instances. This parameter is deprecated.	tv-xxxxx
AckId	string	The ID of the ACK cluster that is associated with the virtual cluster instance.	c809******************************
VNodeCount	integer	The number of vNodes in the virtual cluster instance.	2
FixedVNodeCount	integer
ElasticVNodeCount	integer

Examples

Success response

JSON format

{
  "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	Description
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.