Query RabbitMQ Instance Details with GetInstance API - ApsaraMQ for RabbitMQ - Alibaba Cloud - ApsaraMQ for RabbitMQ

Retrieves an ApsaraMQ for RabbitMQ instance.

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:GetInstance

get

*Instance

acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for RabbitMQ instance.	amqp-cn-v0h1kb9nu***

Response elements

Element	Type	Description	Example
	object	OpenApiResponse
RequestId	string	The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.	92385FD2-624A-48C9-8FB5-753F2AFA***
Data	object	The request result.
Tags	array<object>	The list of tags.
	object	The tag information.
Key	string	The tag key.	tagKey
Value	string	The tag value.	tagValue
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. Note This value is of the Long type. Precision loss may occur in certain programming languages. Handle this value with caution.	1651507200000
OrderCreateTime	integer	The timestamp when the order was created. Unit: milliseconds. Note This value is of the Long type. Precision loss may occur in certain programming languages. Handle this value with caution.	1651507200000
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 applicable to Professional Edition or Enterprise instance. The value -1 is returned.	200
MaxEipTps	integer	The peak TPS for public network traffic. Unit: TPS. Configure this based on the values provided on the ApsaraMQ for RabbitMQ purchase page.	1000
InstanceId	string	The ID of the ApsaraMQ for RabbitMQ instance.	amqp-cn-*********
InstanceType	string	The instance type. Valid values: PROFESSIONAL: Professional Edition. ENTERPRISE: Enterprise Edition. VIP: Platinum Edition. SERVERLESS: Serverless Edition.	enterprise
PublicEndpoint	string	The public endpoint of the instance.	xxx.cn-hangzhou.xxx.net.mq.amqp.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.	1000
AutoRenewInstance	boolean	Indicates whether auto-renewal is enabled for the instance.	false
InstanceName	string	The instance name to be updated. No limit is imposed on the value. The name is up to 64 characters in length.	yunQi-instance
MaxQueue	integer	The maximum number of queues for the instance.	1000
OrderType	string	The order type. Valid values: PRE_PAID: Subscription. POST_PAID: Pay-as-you-go.	PRE_PAID
TracingStorageTime	integer	The retention period of message traces. Unit: days. Valid values: 3: 3 days. 7: 7 days. 15: 15 days. This parameter takes effect only when SupportTracing is set to true.	15
SupportTracing	boolean	Indicates whether the message trace feature is enabled.	True
MaxConnections	integer	The maximum number of connections. Configure this based on the values provided on the ApsaraMQ for RabbitMQ purchase page.	1500
ResourceGroupId	string	The ID of the resource group to which the application belongs.	rg-acfm2vn6jkayvfy
ServerlessSwitch	boolean	The elastic switch.	true
EncryptedInstance	boolean	Indicates whether storage encryption is enabled for instance data.	true
KmsKeyId	string	The ID of the KMS key associated with the cloud disk.	key-hzz6566e86byam3lg5rw4
ProvisionedCapacity	integer	The provisioned 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: tcp_and_ssl or ssl_only. tcp_and_ssl: Both port 5672 and port 5671 are enabled. ssl_only: Only port 5671 is enabled. Valid values: ssl_only : Only the TLS port is enabled. tcp_and_ssl : Both the TCP and TLS ports are enabled.	tcp_and_ssl
VpcId	string	The VPC ID specified when the instance was created. This is used to create a PrivateLink endpoint.	vpc-xxx
SecurityGroupId	string	The security group specified when the instance was created. This is used to create a PrivateLink endpoint.	sg-xxx
VswitchIds	array	The vSwitch IDs specified when the instance was created. These are used to create a PrivateLink endpoint.
	string	The vSwitch ID specified during instance creation.	vsw-xxx

Examples

Success response

JSON format

{
  "RequestId": "92385FD2-624A-48C9-8FB5-753F2AFA***",
  "Data": {
    "Tags": [
      {
        "Key": "tagKey",
        "Value": "tagValue"
      }
    ],
    "Status": "SERVING",
    "SupportEIP": true,
    "ExpireTime": 1651507200000,
    "OrderCreateTime": 1651507200000,
    "PrivateEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com\n",
    "StorageSize": 200,
    "MaxEipTps": 1000,
    "InstanceId": "amqp-cn-*********",
    "InstanceType": "enterprise",
    "PublicEndpoint": "xxx.cn-hangzhou.xxx.net.mq.amqp.aliyuncs.com",
    "ClassicEndpoint": "amqp-cn-st21x7kv****.not-support\n",
    "MaxVhost": 50,
    "MaxTps": 1000,
    "AutoRenewInstance": false,
    "InstanceName": "yunQi-instance",
    "MaxQueue": 1000,
    "OrderType": "PRE_PAID",
    "TracingStorageTime": 15,
    "SupportTracing": true,
    "MaxConnections": 1500,
    "ResourceGroupId": "rg-acfm2vn6jkayvfy",
    "ServerlessSwitch": true,
    "EncryptedInstance": true,
    "KmsKeyId": "key-hzz6566e86byam3lg5rw4",
    "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.