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

Queries the list of ApsaraMQ for RabbitMQ instances and basic information about each instance in a specified region, including instance endpoints and instance 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 that marks the end position of the current query. Pass this value as a parameter in the next call to continue pagination. Set this parameter to an empty string for the first call or when the last page is returned.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	Yes	The maximum number of entries to return. We recommend that you set this parameter to a value between 1 and 100.	1
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs.	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 position from which the current call starts reading. An empty value indicates that all data has been read.	caebacccb2be03f84eb48b699f0a****
MaxResults	integer	The maximum number of entries returned.	1
Instances	array<object>	The instances.
	array<object>	The instances.
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 has been released.	SERVING
SupportEIP	boolean	Indicates whether Elastic IP Address (EIP) is supported.	true
ExpireTime	integer	The timestamp when the instance expires. Unit: milliseconds.	1651507200000
OrderCreateTime	integer	The timestamp when the order was created. Unit: milliseconds.	1572441939000
PrivateEndpoint	string	The VPC endpoint of the instance.	amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com
StorageSize	integer	The disk capacity. Unit: GB. Note This parameter is not available for Professional Edition or Enterprise instances. The value -1 is returned.	200
MaxEipTps	integer	The peak TPS for public network traffic of the instance. Unit: messages per second.	24832
InstanceId	string	The instance ID.	amqp-cn-st21x7kv****
InstanceType	string	The instance type. 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 endpoint. This parameter is no longer used.	amqp-cn-st21x7kv****.not-support
MaxVhost	integer	The maximum number of Vhosts for the instance.	50
MaxTps	integer	The peak TPS for private network traffic of the instance. Unit: messages per second.	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 order type. Valid values: PRE_PAID: subscription. POST_PAID: pay-as-you-go.	PRE_PAID
Tags	array<object>	The tags.
	object	The tags.
Key	string	The tag key.	region
Value	string	The tag value.	hangzhou
ResourceGroupId	string	The resource group ID.	rg-aek3axfj2w4czrq
ServerlessSwitch	boolean	The elastic switch.	true
EncryptedInstance	boolean	Indicates whether storage encryption is enabled for instance data storage.	false
KmsKeyId	string	The ID of the KMS key used for the data cloud disk of the backend storage.	key-bjj66c2a893vmhawtq5fd
ProvisionedCapacity	integer	The reserved TPS capacity for reserved + elastic instances.	2000
Edition	string	The deployment architecture of the Serverless instance. Valid values: shared: Shared architecture. Applicable to reserved + elastic (shared) and pay-as-you-go editions. dedicated: Dedicated architecture. Applicable to reserved + elastic (dedicated) edition.	shared
ListenerMode	string	The port listening mode of the instance. Valid values: tcp_and_ssl: Both ports 5672 and 5671 are enabled. ssl_only: Only port 5671 is enabled. Valid values: tcp_and_ssl : Both ports 5671 and 5672 are supported. ssl_only : Only port 5671 is supported.	tcp_and_ssl
VpcId	string	The VPC ID specified when the instance was created. This value is used to create a PrivateLink endpoint.	vpc-xxx
SecurityGroupId	string	The security group specified when the instance was created. This value is used to create a PrivateLink endpoint.	sg-xxx
VswitchIds	array	The vSwitch IDs specified when the instance was created. These values are used to create a PrivateLink endpoint.
	string	The vSwitch ID specified when the instance was created.	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": true,
        "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.