调用DescribeInstances查询一个或多个Redis实例的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstances |
系统规定参数,取值:DescribeInstances。 |
RegionId | String | 否 | cn-hangzhou |
实例所属的地域ID。 |
InstanceIds | String | 否 | r-bp1zxszhcgatnx**** |
需要查询的实例ID。 说明 如需传入多个实例ID时,使用英文逗号(,)分隔实例ID。
|
InstanceStatus | String | 否 | Normal |
实例状态,取值:
|
ChargeType | String | 否 | PostPaid |
付费类型,取值:
|
NetworkType | String | 否 | CLASSIC |
网络类型,取值:
|
EngineVersion | String | 否 | 4.0 |
Redis实例的引擎版本,取值:2.8、4.0、5.0或6.0。 |
InstanceClass | String | 否 | redis.master.small.default |
实例规格,请参见实例规格表。 |
VpcId | String | 否 | vpc-bp1nme44gek34slfc**** |
专有网络ID。 |
VSwitchId | String | 否 | vsw-bp1e7clcw529l773d**** |
虚拟交换机ID。 |
PageNumber | Integer | 否 | 1 |
实例列表的页码,起始值为1,默认值为1。 |
PageSize | Integer | 否 | 10 |
每页最多可显示的行数,最大值为50,默认值为10。 |
InstanceType | String | 否 | Redis |
引擎类型,取值:
|
SearchKey | String | 否 | apitest |
实例名称。 |
ArchitectureType | String | 否 | standard |
架构类型,取值:
|
Expired | String | 否 | false |
实例的过期状态,取值:
|
ZoneId | String | 否 | cn-hongkong-b |
可用区ID。 |
Tag.N.Key | String | 否 | {“key1”:”value1”,“key2”:”value2”} |
标签的键,与Tag Value组成标签的键值对,格式为{"key1":"value1","key2":"value2"}。 说明 单次最多支持传入5组标签的键值对。
|
Tag.N.Value | String | 否 | {“key1”:”value1”,“key2”:”value2”} |
标签键的值,与Tag Key组成标签的键值对。 |
ResourceGroupId | String | 否 | rg-acfmyiu4ekp**** |
资源组ID。 说明 您可以通过调用ListResourceGroups接口或通过控制台获取资源组ID列表。相关操作,请参见查看资源组基本信息。
|
GlobalInstance | Boolean | 否 | true |
返回的实例列表中,是否过滤分布式实例中的子实例,取值:
|
EditionType | String | 否 | Enterprise |
实例类型,取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 1 |
实例总个数。 |
PageNumber | Integer | 1 |
实例列表的页码。 |
PageSize | Integer | 30 |
输入时设置的每页行数。 |
Instances | Array of KVStoreInstance |
由Instance组成的集合。 |
|
KVStoreInstance | |||
ArchitectureType | String | cluster |
架构类型,返回值:
|
Bandwidth | Long | 96 |
实例带宽,单位:MB/s。 |
Capacity | Long | 4096 |
实例容量, 单位:MB。 |
ChargeType | String | PostPaid |
付费类型,返回值:
|
Config | String | {\"maxmemory-policy\":\"volatile-lfu\",\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64,\"#no_loose_disabled-commands\":\"flushall,flushdb\",\"lazyfree-lazy-eviction\":\"yes\"} |
实例的参数设置情况,详情请参见参数设置。 |
ConnectionDomain | String | r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com |
实例的内网连接地址。 |
ConnectionMode | String | Standard |
实例的访问模式,返回值:
|
Connections | Long | 20000 |
实例的连接数限制。 |
CreateTime | String | 2018-11-07T08:49:00Z |
实例的创建时间。 |
DestroyTime | String | 2019-04-28T10:03:01Z |
销毁实例的时间。 |
EndTime | String | 2019-06-13T16:00:00Z |
包年包月实例到期时间。 |
EngineVersion | String | 4.0 |
Redis实例的引擎版本,返回值:2.8、4.0、5.0或6.0。 |
HasRenewChangeOrder | Boolean | false |
是否有未生效的续费变配订单,返回值:
|
InstanceClass | String | redis.logic.sharding.2g.2db.0rodb.4proxy.default |
实例的规格。 |
InstanceId | String | r-bp1zxszhcgatnx**** |
实例的ID。 |
InstanceName | String | apitest |
实例的名称。 |
InstanceStatus | String | Normal |
实例的状态。 |
InstanceType | String | Redis |
实例类型。 |
IsRds | Boolean | true |
是否属RDS管控,返回值:
|
NetworkType | String | CLASSIC |
网络类型,返回值:
|
NodeType | String | double |
节点类型,返回值:
|
PackageType | String | standard |
套餐类型,返回值:
|
Port | Long | 6379 |
Redis服务端口。 |
PrivateIp | String | 172.16.49.*** |
内网IP地址。 |
QPS | Long | 100000 |
每秒请求数(Queries per Second)。 |
RegionId | String | cn-hongkong |
地域ID。 |
ReplacateId | String | grr-bp11381ebc16**** |
多活实例的逻辑ID。 |
ResourceGroupId | String | rg-acfmyiu4ekp**** |
实例所属的资源组ID。 |
SearchKey | String | apitest |
基于实例ID或者实例备注模糊搜索时使用的关键字。 |
ShardCount | Integer | 3 |
集群的数据节点数量。 说明 当Redis实例为云盘版(集群架构)时才会返回本参数。
|
Tags | Array of Tag |
标签信息。 |
|
Tag | |||
Key | String | key1 |
Tag的Key。 |
Value | String | value1 |
Tag的Value。 |
UserName | String | r-bp1zxszhcgatnx**** |
连接使用的用户名,默认包含有一个以实例ID命名的用户名。 |
VSwitchId | String | vsw-bp1e7clcw529l773d**** |
虚拟交换机的ID。 |
VpcId | String | vpc-bp1nme44gek34slfc**** |
专有网络(VPC)的ID。 |
ZoneId | String | cn-hongkong-b |
可用区ID。 |
RequestId | String | 1E83311F-0EE4-4922-A3BF-730B312B**** |
请求ID。 |
示例
请求示例
https://r-kvstore.aliyuncs.com/?Action=DescribeInstances
&<公共请求参数>
正常返回示例
XML
格式
<DescribeInstancesResponse>
<Instances>
<KVStoreInstance>
<Connections>10000</Connections>
<ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
<Config>{"EvictionPolicy":"volatile-lru","hash-max-ziplist-entries":512,"zset-max-ziplist-entries":128,"list-max-ziplist-entries":512,"list-max-ziplist-value":64,"zset-max-ziplist-value":64,"set-max-intset-entries":512,"hash-max-ziplist-value":64}</Config>
<Port>6379</Port>
<HasRenewChangeOrder>false</HasRenewChangeOrder>
<ConnectionDomain>r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com</ConnectionDomain>
<Capacity>1024</Capacity>
<QPS>80000</QPS>
<PrivateIp>172.16.49.***</PrivateIp>
<InstanceStatus>Normal</InstanceStatus>
<NetworkType>VPC</NetworkType>
<Bandwidth>10</Bandwidth>
<PackageType>standard</PackageType>
<InstanceType>Redis</InstanceType>
<Tags>
<Tag>
<Value>社区版</Value>
<Key>类型</Key>
</Tag>
</Tags>
<ArchitectureType>standard</ArchitectureType>
<UserName>r-bp1wcw2rlw76ac****</UserName>
<EngineVersion>5.0</EngineVersion>
<ZoneId>cn-hangzhou-f</ZoneId>
<InstanceId>r-bp1wcw2rlw76ac****</InstanceId>
<VSwitchId>vsw-bp1w9ouei2nm66qlz****</VSwitchId>
<CreateTime>2020-03-31T06:56:22Z</CreateTime>
<InstanceClass>redis.master.small.default</InstanceClass>
<IsRds>true</IsRds>
<InstanceName>社区主从50</InstanceName>
<VpcId>vpc-bp1opxu1zkhn00gzv****</VpcId>
<ChargeType>PostPaid</ChargeType>
<NodeType>double</NodeType>
<RegionId>cn-hangzhou</RegionId>
</KVStoreInstance>
</Instances>
<TotalCount>1</TotalCount>
<RequestId>78DDAA9A-B09E-4BE0-AEAE-10A22924****</RequestId>
<PageSize>30</PageSize>
<PageNumber>1</PageNumber>
</DescribeInstancesResponse>
JSON
格式
{
"Instances": {
"KVStoreInstance": [
{
"Connections": 10000,
"ResourceGroupId": "rg-acfmyiu4ekp****",
"Config": "{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}",
"Port": 6379,
"HasRenewChangeOrder": false,
"ConnectionDomain": "r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com",
"Capacity": 1024,
"QPS": 80000,
"PrivateIp": "172.16.49.***",
"InstanceStatus": "Normal",
"NetworkType": "VPC",
"Bandwidth": 10,
"PackageType": "standard",
"InstanceType": "Redis",
"Tags": {
"Tag": [
{
"Value": "社区版",
"Key": "类型"
}
]
},
"ArchitectureType": "standard",
"UserName": "r-bp1wcw2rlw76ac****",
"EngineVersion": "5.0",
"ZoneId": "cn-hangzhou-f",
"InstanceId": "r-bp1wcw2rlw76ac****",
"VSwitchId": "vsw-bp1w9ouei2nm66qlz****",
"CreateTime": "2020-03-31T06:56:22Z",
"InstanceClass": "redis.master.small.default",
"IsRds": true,
"InstanceName": "社区主从50",
"VpcId": "vpc-bp1opxu1zkhn00gzv****",
"ChargeType": "PostPaid",
"NodeType": "double",
"RegionId": "cn-hangzhou"
}
]
},
"TotalCount": 1,
"RequestId": "78DDAA9A-B09E-4BE0-AEAE-10A22924****",
"PageSize": 30,
"PageNumber": 1
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidInstanceIds.Malformed | The Specified parameter "InstanceIds" is not valid. | InstanceIds验证失败 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交