RabbitMQ Instance Query API Overview - ApsaraMQ for RabbitMQ - Alibaba Cloud - ApsaraMQ for RabbitMQ

Queries a list of ApsaraMQ for RabbitMQ instances in a specified region and returns basic information about each instance, such as its endpoints and specification limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

amqp:ListInstance

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token to retrieve the next page of results. If this is your first query, leave this parameter empty.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	Yes	The maximum number of results to return. The recommended value is from 1 to 100.	1
ResourceGroupId	string	No	The ID of the resource group that contains the instance.	rg-aekzu74zjgdu4mq

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CCBB1225-C392-480E-8C7F-D09AB2CD2***
Data	object	The returned data.
NextToken	string	The token for the next page of results. If this field is empty, it means all results have been returned.	caebacccb2be03f84eb48b699f0a****
MaxResults	integer	The maximum number of entries returned per page.	1
Instances	array<object>	A list of instances.
	array<object>	An instance.
Status	string	The instance status. Valid values: DEPLOYING: The instance is being deployed. EXPIRED: The instance has expired. SERVING: The instance is running. RELEASED: The instance is released.	SERVING
SupportEIP	boolean	Indicates whether the instance supports EIPs.	true
ExpireTime	integer	The expiration timestamp of the instance, in milliseconds.	1651507200000
OrderCreateTime	integer	The creation timestamp of the order, in milliseconds.	1572441939000
PrivateEndpoint	string	The VPC endpoint of the instance.	amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com
StorageSize	integer	The storage capacity of the disk. Unit: GB. Note This parameter returns a value of -1 for Professional Edition and Enterprise Edition instances, to which it does not apply.	200
MaxEipTps	integer	The peak transactions per second (TPS) of the instance over the public network.	24832
InstanceId	string	The instance ID.	amqp-cn-st21x7kv****
InstanceType	string	The instance type. Valid values: professional: Professional Edition enterprise: Enterprise Edition vip: Platinum Edition	professional
PublicEndpoint	string	The public endpoint of the instance.	amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com
ClassicEndpoint	string	The classic network endpoint. This parameter is deprecated.	amqp-cn-st21x7kv****.not-support
MaxVhost	integer	The maximum number of vhosts for the instance.	50
MaxTps	integer	The peak transactions per second (TPS) of the instance over the private network.	5000
AutoRenewInstance	boolean	Indicates whether auto-renewal is enabled for the instance.	false
InstanceName	string	The instance name.	amqp-cn-st21x7kv****
MaxQueue	integer	The maximum number of queues for the instance.	50
OrderType	string	The billing method. Valid values: PRE_PAID: The instance uses the subscription billing method. POST_PAID: The instance uses the pay-as-you-go billing method.	PRE_PAID
Tags	array<object>	The tags attached to the instance.
	object	The tag.
Key	string	The tag key.	region
Value	string	The tag value.	hangzhou
ResourceGroupId	string	The resource group ID.	rg-aek3axfj2w4czrq
ServerlessSwitch	boolean
EncryptedInstance	boolean	Indicates whether storage encryption is enabled for the instance.	false
KmsKeyId	string	The ID of the KMS key used for data disk encryption.	key-bjj66c2a893vmhawtq5fd
ProvisionedCapacity	integer	The reserved TPS capacity for reserved and elastic instances.	2000
Edition	string	The deployment architecture, which is applicable only to Serverless Edition instances. Valid values: shared: A shared architecture, used for reserved, elastic (shared), and pay-as-you-go instances. dedicated: A dedicated architecture, used for reserved and elastic (dedicated) instances.	shared
ListenerMode	string	The port listener mode of the instance. `tcp_and_ssl` enables both port `5672` and port `5671`, while `ssl_only` enables only port `5671`.	tcp_and_ssl
VpcId	string	The ID of the VPC in which the instance resides. This VPC is used for PrivateLink endpoint creation.	vpc-xxx
SecurityGroupId	string	The ID of the security group to which the instance belongs. This security group is used for PrivateLink endpoint creation.	sg-xxx
VswitchIds	array	The IDs of the VSwitches to which the instance is connected. These VSwitches are used for PrivateLink endpoint creation.
	string	A VSwitch ID to which the instance is connected.	vsw-xxx

Examples

Success response

JSON format

{
  "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",
        "ServerlessSwitch": false,
        "EncryptedInstance": false,
        "KmsKeyId": "key-bjj66c2a893vmhawtq5fd",
        "ProvisionedCapacity": 2000,
        "Edition": "shared",
        "ListenerMode": "tcp_and_ssl",
        "VpcId": "vpc-xxx",
        "SecurityGroupId": "sg-xxx",
        "VswitchIds": [
          "vsw-xxx"
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.