Queries all ApsaraMQ for RabbitMQ instances in a specific region. Details about each instance are also returned in the result, including the endpoints and specification limits.
Request parameters
Parameter |
Type |
Required |
Example |
Description |
Action | String | Yes | ListInstances | The operation that you want to perform. Set this parameter to ListInstances. |
NextToken | String | No | caeba0bbb2be03f84eb48b699f0a**** | The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string. |
MaxResults | Integer | Yes | 1 | The maximum number of entries to return. Valid values: 1 to 100. |
Response parameters
Parameter |
Type |
Example |
Description |
RequestId | String | CCBB1225-C392-480E-8C7F-D09AB2CD2*** | The request ID. |
Data | Object | The returned data. |
|
NextToken | String | caebacccb2be03f84eb48b699f0a**** | The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved. |
MaxResults | Integer | 1 | The maximum number of entries returned. |
Instances | Array of InstanceVO | The instances. |
|
Status | String | SERVING | The instance status. Valid values:
|
SupportEIP | Boolean | true | Indicates whether the instance supports elastic IP addresses (EIPs). |
ExpireTime | Long | 1651507200000 | The timestamp that indicates when the instance expires. Unit: milliseconds. |
OrderCreateTime | Long | 1572441939000 | The timestamp that indicates when the order was created. Unit: milliseconds. |
PrivateEndpoint | String | amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com | The virtual private cloud (VPC) endpoint of the instance. |
StorageSize | Integer | 200 | The disk size. Unit: GB. Note For Professional Edition instances or Enterprise Edition instances, this parameter is unavailable and -1 is returned. |
MaxEipTps | Integer | 24832 | The maximum number of Internet-based transactions per second (TPS) for the instance. |
InstanceId | String | amqp-cn-st21x7kv**** | The instance ID. |
InstanceType | String | professional | The instance edition. Valid values:
|
PublicEndpoint | String | amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com | The public endpoint of the instance. |
ClassicEndpoint | String | amqp-cn-st21x7kv****.not-support | The endpoint that is used to access the instance over the classic network. This parameter is no longer available. |
MaxVhost | Integer | 50 | The maximum number of vhosts that can be created on the instance. |
MaxTps | Integer | 5000 | The maximum number of VPC-based TPS on the instance. |
AutoRenewInstance | Boolean | false | Indicates whether the instance is automatically renewed. |
InstanceName | String | amqp-cn-st21x7kv**** | The instance name. |
MaxQueue | Integer | 50 | The maximum number of queues on the instance. |
OrderType | String | PRE_PAID | The billing method. Valid values:
|
Tags | Array of tags | The tags. |
|
Key | String | region | The tag key. |
Value | String | hangzhou | The tag value. |
Examples
Sample request
http(s)://amqp-open.cn-hangzhou.aliyuncs.com/?Action=ListInstances
&MaxResults=1
&RegionId=cn-hangzhou
&<Common request parameters>
Sample success responses
XML
format
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
format
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
}
}
Error codes
For a list of error codes, see Service error codes.