ListInstances - ApsaraMQ for RabbitMQ - Alibaba Cloud Documentation Center

Queries all AparaMQ for RabbitMQ instances in a region. The returned data includes the basic information, endpoint, and specification limits of each instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
amqp:ListInstance	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	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.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	Yes	The maximum number of entries to return. Valid values: 1 to 100.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	CCBB1225-C392-480E-8C7F-D09AB2CD2***
Data	object	The returned data.
NextToken	string	The token that marks the end of the current returned page. If this parameter is empty, all data is retrieved.	caebacccb2be03f84eb48b699f0a****
MaxResults	integer	The maximum number of entries returned.	1
Instances	array<object>	The instances.
	object
Status	string	The instance status. Valid values: DEPLOYING: The instance is being deployed. EXPIRED: The instance is expired. SERVING: The instance is running. RELEASED: The instance is released.	SERVING
SupportEIP	boolean	Indicates whether the instance supports elastic IP addresses (EIPs).	true
ExpireTime	long	The timestamp that indicates when the instance expires. Unit: milliseconds.	1651507200000
OrderCreateTime	long	The timestamp that indicates when the order was created. Unit: milliseconds.	1572441939000
PrivateEndpoint	string	The virtual private cloud (VPC) endpoint of the instance.	amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com
StorageSize	integer	The disk size. Unit: GB. Note For Professional Edition instances and Enterprise Edition instances, this parameter is unavailable and -1 is returned.	200
MaxEipTps	integer	The maximum number of Internet-based transactions per second (TPS) for the instance.	24832
InstanceId	string	The instance ID	amqp-cn-st21x7kv****
InstanceType	string	The instance type. PROFESSIONAL: Professional Edition ENTERPRISE: Enterprise Edition VIP: Enterprise Platinum Edition	professional
PublicEndpoint	string	The public endpoint of the instance.	amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com
ClassicEndpoint	string	The endpoint that is used to access the instance over the classic network. This parameter is no longer available.	amqp-cn-st21x7kv****.not-support
MaxVhost	integer	The maximum number of vhosts on the instance.	50
MaxTps	integer	The maximum number of VPC-based TPS for the instance.	5000
AutoRenewInstance	boolean	Indicates whether the instance is automatically renewed.	false
InstanceName	string	The instance name.	amqp-cn-st21x7kv****
MaxQueue	integer	The maximum number of queues on the instance.	50
OrderType	string	The billing method. Valid values: PrePaid: the subscription billing method. POST_PAID: the pay-as-you-go billing method.	PRE_PAID

Examples

Sample success responses

JSONformat

{
  "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"
          }
        ]
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-11-07	The response structure of the API has changed	View Change Details