ListInstances - 查询实例列表
查询指定地域下的云消息队列 RabbitMQ 版实例列表以及各实例的基本信息，包括实例接入点、实例规格上限等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
amqp:ListInstance |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| NextToken |
string |
否 |
用来标记当前查询结束的位置，以便下一次调用时作为参数传入，继续翻页。首次调用或返回最后一页时，取值为空字符串。 |
caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults |
integer |
是 |
最大结果集。建议取值在 1~100 之间。 |
1 |
| ResourceGroupId |
string |
否 |
实例所属资源组 ID。 |
rg-aekzu74zjgdu4mq |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
CCBB1225-C392-480E-8C7F-D09AB2CD2*** |
| Data |
object |
数据。 |
|
| NextToken |
string |
表示当前调用返回读取到的位置，空代表数据已经读取完毕。 |
caebacccb2be03f84eb48b699f0a**** |
| MaxResults |
integer |
最大结果集。 |
1 |
| Instances |
array<object> |
实例。 |
|
|
object |
实例。 |
||
| Status |
string |
实例状态。取值如下：
|
SERVING |
| SupportEIP |
boolean |
是否支持 EIP。 |
true |
| ExpireTime |
integer |
实例过期的时间戳，单位：毫秒。 |
1651507200000 |
| OrderCreateTime |
integer |
订单创建的时间戳，单位：毫秒。 |
1572441939000 |
| PrivateEndpoint |
string |
实例的 VPC 接入点。 |
amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com |
| StorageSize |
integer |
磁盘容量，单位：GB。 说明
专业版实例和企业版实例无此参数，返回**-1**。 |
200 |
| MaxEipTps |
integer |
实例的公网 TPS 流量峰值，单位：条/秒。 |
24832 |
| InstanceId |
string |
实例 ID。 |
amqp-cn-st21x7kv**** |
| InstanceType |
string |
实例类型。
|
professional |
| PublicEndpoint |
string |
实例的公网接入点。 |
amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com |
| ClassicEndpoint |
string |
经典接入点，该参数不再使用。 |
amqp-cn-st21x7kv****.not-support |
| MaxVhost |
integer |
实例的 Vhost 的数量上限，单位：个。 |
50 |
| MaxTps |
integer |
实例的私网 TPS 流量峰值，单位：条/秒。 |
5000 |
| AutoRenewInstance |
boolean |
是否自动更新实例。 |
false |
| InstanceName |
string |
实例名称。 |
amqp-cn-st21x7kv**** |
| MaxQueue |
integer |
实例的 Queue 的数量上限，单位：个。 |
50 |
| OrderType |
string |
订单类型。
|
PRE_PAID |
| Tags |
array<object> |
标签列表。 |
|
|
object |
标签列表。 |
||
| Key |
string |
标签键。 |
region |
| Value |
string |
标签值。 |
hangzhou |
| ResourceGroupId |
string |
资源组 ID。 |
rg-aek3axfj2w4czrq |
| EncryptedInstance |
boolean |
实例数据存储是否开启存储加密 |
false |
| KmsKeyId |
string |
后端存储使用数据盘对应的 KMS 密钥 ID。 |
key-bjj66c2a893vmhawtq5fd |
| ProvisionedCapacity |
integer |
||
| Edition |
string |
示例
正常返回示例
JSON格式
{
"RequestId": "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
"Data": {
"NextToken": "caebacccb2be03f84eb48b699f0a****",
"MaxResults": 1,
"Instances": [
{
"Status": "SERVING",
"SupportEIP": true,
"ExpireTime": 1651507200000,
"OrderCreateTime": 1572441939000,
"PrivateEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com",
"StorageSize": 200,
"MaxEipTps": 24832,
"InstanceId": "amqp-cn-st21x7kv****",
"InstanceType": "professional",
"PublicEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com",
"ClassicEndpoint": "amqp-cn-st21x7kv****.not-support",
"MaxVhost": 50,
"MaxTps": 5000,
"AutoRenewInstance": false,
"InstanceName": "amqp-cn-st21x7kv****",
"MaxQueue": 50,
"OrderType": "PRE_PAID",
"Tags": [
{
"Key": "region",
"Value": "hangzhou"
}
],
"ResourceGroupId": "rg-aek3axfj2w4czrq",
"EncryptedInstance": false,
"KmsKeyId": "key-bjj66c2a893vmhawtq5fd",
"ProvisionedCapacity": 0,
"Edition": ""
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。