ListInstances
更新时间:
查询指定地域下的云消息队列 RabbitMQ 版实例列表以及各实例的基本信息,包括实例接入点、实例规格上限等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ListInstances | 系统规定参数。取值:ListInstances。 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** | 用来标记当前查询结束的位置,以便下一次调用时作为参数传入,继续翻页。首次调用或返回最后一页时,取值为空字符串。 |
MaxResults | Integer | 是 | 1 | 最大结果集。建议取值在1~100之间。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | CCBB1225-C392-480E-8C7F-D09AB2CD2*** | 请求ID。 |
Data | Object | 数据。 |
|
NextToken | String | caebacccb2be03f84eb48b699f0a**** | 表示当前调用返回读取到的位置,空代表数据已经读取完毕。 |
MaxResults | Integer | 1 | 最大结果集。 |
Instances | Array of InstanceVO | 实例。 |
|
Status | String | SERVING | 实例状态。取值如下:
|
SupportEIP | Boolean | true | 是否支持EIP。 |
ExpireTime | Long | 1651507200000 | 实例过期的时间戳,单位:毫秒。 |
OrderCreateTime | Long | 1572441939000 | 订单创建的时间戳,单位:毫秒。 |
PrivateEndpoint | String | amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com | 实例的VPC接入点。 |
StorageSize | Integer | 200 | 磁盘容量,单位:GB。 说明 专业版实例和企业版实例无此参数,返回-1。 |
MaxEipTps | Integer | 24832 | 实例的公网TPS流量峰值,单位:条/秒。 |
InstanceId | String | amqp-cn-st21x7kv**** | 实例ID。 |
InstanceType | String | professional | 实例类型。
|
PublicEndpoint | String | amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com | 实例的公网接入点。 |
ClassicEndpoint | String | amqp-cn-st21x7kv****.not-support | 经典接入点,该参数不再使用。 |
MaxVhost | Integer | 50 | 实例的Vhost的数量上限,单位:个。 |
MaxTps | Integer | 5000 | 实例的私网TPS流量峰值,单位:条/秒。 |
AutoRenewInstance | Boolean | false | 是否自动更新实例。 |
InstanceName | String | amqp-cn-st21x7kv**** | 实例名称。 |
MaxQueue | Integer | 50 | 实例的Queue的数量上限,单位:个。 |
OrderType | String | PRE_PAID | 订单类型。
|
Tags | Array of tags | 标签列表。 |
|
Key | String | region | 标签键。 |
Value | String | hangzhou | 标签值。 |
示例
请求示例
http(s)://amqp-open.cn-hangzhou.aliyuncs.com/?Action=ListInstances
&MaxResults=1
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListInstancesResponse>
<RequestId>CCBB1225-C392-480E-8C7F-D09AB2CD2***</RequestId>
<Data>
<Instances>
<Status>SERVING</Status>
<MaxTps>5000</MaxTps>
<MaxEipTps>24832</MaxEipTps>
<ClassicEndpoint>amqp-cn-st21x7kv****.not-support</ClassicEndpoint>
<InstanceId>amqp-cn-st21x7kv****</InstanceId>
<MaxQueue>50</MaxQueue>
<SupportEIP>true</SupportEIP>
<StorageSize>200</StorageSize>
<InstanceName>amqp-cn-st21x7kv****</InstanceName>
<OrderType>PRE_PAID</OrderType>
<OrderCreateTime>1572441939000</OrderCreateTime>
<MaxVhost>50</MaxVhost>
<PublicEndpoint>amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com</PublicEndpoint>
<InstanceType>professional</InstanceType>
<ExpireTime>1651507200000</ExpireTime>
<AutoRenewInstance>false</AutoRenewInstance>
<PrivateEndpoint>amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com</PrivateEndpoint>
</Instances>
<NextToken></NextToken>
<MaxResults>1</MaxResults>
</Data>
</ListInstancesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
"Data" : {
"Instances" : {
"Status" : "SERVING",
"MaxTps" : 5000,
"MaxEipTps" : 24832,
"ClassicEndpoint" : "amqp-cn-st21x7kv****.not-support",
"InstanceId" : "amqp-cn-st21x7kv****",
"MaxQueue" : 50,
"SupportEIP" : true,
"StorageSize" : 200,
"InstanceName" : "amqp-cn-st21x7kv****",
"OrderType" : "PRE_PAID",
"OrderCreateTime" : 1572441939000,
"MaxVhost" : 50,
"PublicEndpoint" : "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com",
"InstanceType" : "professional",
"ExpireTime" : 1651507200000,
"AutoRenewInstance" : false,
"PrivateEndpoint" : "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com"
},
"NextToken" : "",
"MaxResults" : 1
}
}
错误码
访问错误中心查看更多错误码。
文档内容是否对您有帮助?