查询一个或多个Tair KVCache实例的信息。
接口说明
本接口支持查询 Tair KVCache 的推理算子实例、虚拟集群实例、缓存服务实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| kvstore:DescribeTairKVCacheInferInstances | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 实例所属的地域 ID。 | cn-beijing |
| InstanceIds | string | 否 | 需要查询的实例 ID。 说明
如需传入多个实例 ID 时,使用英文逗号(,)分隔实例 ID,最多一个请求传入 30 个实例 ID。
| tk-2zefe7728c2c**** |
| InstanceStatus | string | 否 | Normal | |
| ChargeType | string | 否 | 实例的付费类型,取值:
| PrePaid |
| NetworkType | string | 否 | 网络类型,取值:
| VPC |
| InstanceClass | string | 否 | 实例规格 | kvcache.cu.g4c.2 |
| VpcId | string | 否 | 专有网络 ID。 | vpc-bp1nme44gek34slfc**** |
| VSwitchId | string | 否 | 虚拟交换机 ID。 | vsw-bp1e7clcw529l773d**** |
| PageNumber | integer | 否 | 实例列表的页码,起始值为 1,默认值为 1。 | 1 |
| PageSize | integer | 否 | 分页大小,默认为 30。 | 30 |
| SearchKey | string | 否 | 支持模糊搜索实例名称或实例 ID。 | apitest |
| Expired | string | 否 | 实例的过期状态,取值:
| false |
| ZoneId | string | 否 | 可用区 ID。 | cn-hangzhou-e |
| ResourceGroupId | string | 否 | 资源组 ID,可以为空。 | rg-acfmyiu4ekp**** |
| Tag | array<object> | 否 | 实例的标签信息。 | |
| object | 否 | 实例的标签信息。 | ||
| Key | string | 否 | 标签的键,与 Tag Value 组成标签的键值对。 说明
单次最多支持传入 5 组标签的键值对。
| key1_test |
| Value | string | 否 | 标签的值。 说明
N 表示传入第几个标签的值。例如Tag.1.Value表示传入第一个标签的值;Tag.2.Value表示传入第二个标签的值。
| testvalue |
| PrivateIp | string | 否 | 专有网络 IP 地址。该参数已弃用。 | 172.16.49.*** |
返回参数
示例
正常返回示例
JSON格式
{
"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
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | InvalidInstanceIds.Malformed | The Specified parameter InstanceIds is not valid. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-11-27 | 新增 OpenAPI | 查看变更详情 |
