DescribeInstances_云数据库 Tair（兼容 Redis®）_API文档-阿里云OpenAPI开发者门户

流控信息

请求速率为100/1(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

kvstore:DescribeInstances	List	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/* DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	无	无

请求参数

字段名称	字段详情
RegionIdstring	实例所属的地域 ID。展开详情示例值:cn-hangzhou参考取值来源: DescribeRegions
InstanceIdsstring	需要查询的实例 ID。展开详情示例值:r-bp1zxszhcgatnx****参考取值来源: RestartInstance CreateInstances ModifyInstanceSSL DescribeInstanceSSL
InstanceStatusstring	实例状态，取值：展开详情示例值:Normal
ChargeTypestring	付费类型，取值：展开详情示例值:PostPaid枚举值:PrePaidPostPaid
NetworkTypestring	网络类型，取值：展开详情示例值:CLASSIC枚举值:CLASSICVPC
EngineVersionstring	实例兼容 Redis 的版本，取值：2.8、4.0、5.0、6.0或7.0。示例值:4.0枚举值:1.02.84.05.06.07.0
InstanceClassstring	实例规格，请参见实例规格表。示例值:redis.master.small.default参考取值来源: CreateTairInstance DescribeDedicatedClusterInstanceList
VpcIdstring	专有网络 ID。示例值:vpc-bp1nme44gek34slfc****
VSwitchIdstring	虚拟交换机 ID。示例值:vsw-bp1e7clcw529l773d****
PageNumberinteger<int32>	实例列表的页码，起始值为 1，默认值为 1。示例值:1取值 >= 1
PageSizeinteger<int32>	每页最多可显示的行数，最大值为 50，默认值为 30。示例值:30取值 <= 1000
InstanceTypestring	实例类型，取值：展开详情示例值:Redis枚举值:RedisMemcachetair_essdtair_scmTairtair_rdbtair_skv参考取值来源: CreateTairInstance DescribeLogicInstanceTopology
SearchKeystring	支持模糊搜索实例名称或实例 ID。示例值:apitest
ArchitectureTypestring	架构类型，取值：展开详情示例值:standard
Expiredstring	实例的过期状态，取值：展开详情示例值:false
ZoneIdstring	可用区 ID。示例值:cn-hongkong-b参考取值来源: DescribeZones
ResourceGroupIdstring	资源组 ID。展开详情示例值:rg-acfmyiu4ekp****
GlobalInstanceboolean	返回的实例列表中，是否过滤分布式实例中的子实例，取值：展开详情示例值:true
EditionTypestring	实例类型，取值：展开详情示例值:Enterprise枚举值:EnterpriseCommunity
PrivateIpstring	专有网络 IP 地址。示例值:172.16.49.***
Tagarray<object>	实例的标签信息。子级条数 <= 21

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:1E83311F-0EE4-4922-A3BF-730B312B****
PageNumberinteger<int32>	实例列表的页码。示例值:1
PageSizeinteger<int32>	输入时设置的每页行数。示例值:30
TotalCountinteger<int32>	实例总个数。示例值:1
Instancesobject

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-27	变更请求参数InstanceType
	2024-10-09	变更返回参数
	2024-06-19	变更返回参数
	2023-04-13	变更返回参数

1
2
10 条/页

DescribeInstances_云数据库 Tair（兼容 Redis®）_API文档

流控信息

授权信息

请求参数

返回参数

错误码

变更历史

相关示例