# Alibaba Cloud MQ for RabbitMQ API

> Alibaba Cloud MQ for RabbitMQ API on Apizie: 40 endpoints (Adds an instance whitelist. Only new-architecture instances are supported, that is, instances whose VPC…, Transfers a RabbitMQ instance to a different resource group, When an open-source client accesses an ApsaraMQ for RabbitMQ server, it must provide a username and password…, A producer sends a message to an exchange, which then routes the message to a specified queue or another…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-amqp-open/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-amqp-open`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/amqp-open
- Page: https://apizie.tech/api/cloud/aliyun-amqp-open
- OpenAPI: https://apizie.tech/api/cloud/aliyun-amqp-open/openapi.json

Alibaba Cloud OpenAPI for MQ for RabbitMQ (amqp-open, version 2019-12-12). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds an instance whitelist. Only new-architecture instances are supported, that is, instances whose VPC…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/add-instance-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the instance for which you want to create an IP or VPC whitelist |
| WhiteListItem | string | yes | The whitelist IP address or VPC ID. IP addresses are specified in CIDR block format (JSON-encoded) |
| WhiteListType | integer | yes | The whitelist type. If WhiteListType is set to 1, the whitelist is an IP whitelist. If WhiteListType is set to 2, the whitelist is a VPC… |

### Transfers a RabbitMQ instance to a different resource group
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The instance ID of the RabbitMQ instance |
| NewResourceGroupId | string | yes | The ID of the destination resource group |
| ResourceType | string | no | The resource type. Currently, only Instance is supported |

### When an open-source client accesses an ApsaraMQ for RabbitMQ server, it must provide a username and password…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/create-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance. This specifies the instance for which you want to create a static username and password |
| accountAccessKey | string | yes | The AccessKey ID of your Alibaba Cloud account or RAM user. For more information about how to obtain an AccessKey ID, see… |
| userName | string | yes | The static username that you want to create. The value of this parameter is a Base64-encoded string that is constructed from the instance… |
| signature | string | yes | The signature. The system calculates the static password based on the signature, the AccessKey secret signature, and the username. The… |
| createTimestamp | integer | yes | The timestamp that indicates when the username and password are created. Unit: milliseconds. This timestamp is used to calculate the… |
| secretSign | string | yes | The signature of the AccessKey secret. The system calculates the static password based on the signature, the AccessKey secret signature,… |
| Remark | string | no | The remarks on the static user |

### A producer sends a message to an exchange, which then routes the message to a specified queue or another…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/create-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The name of the vhost. The vhost must be created in the console. Both `DestinationName` and `SourceExchange` must belong to this vhost |
| SourceExchange | string | yes | The name of the source exchange. This exchange must be created in the console |
| DestinationName | string | yes | The name of the binding destination. The destination must be created in the console. It must belong to the same vhost as `SourceExchange`.… |
| BindingKey | string | no | The binding key. If the source exchange is not a topic exchange: It can contain letters, digits, hyphens (-), underscores (_), periods… |
| BindingType | string | yes | The type of the destination object. Valid values: 0: Queue 1: Exchange |
| Argument | string | no | The key-value pairs for the message header attributes. The message header attributes consist of one or more key-value pairs. The x-match… |

### Creates an exchange
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/create-exchange` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| VirtualHost | string | yes | The name of the vhost to which the exchange belongs |
| ExchangeName | string | yes | The exchange name. Note The exchange name can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#),… |
| ExchangeType | string | yes | The exchange type. Valid values: DIRECT: This type routes messages to the queue whose binding key exactly matches the routing key. TOPIC:… |
| XDelayedType | string | no | An x-delayed-message exchange allows you to customize the header attributes of a message. The x-delay header specifies the delay period… |
| AutoDeleteState | string | yes | Specifies whether to automatically delete the exchange. Valid values: true: The exchange is automatically deleted when the last queue… |
| Internal | string | yes | Specifies whether the exchange is an internal exchange. Valid values: false: No. true: Yes |
| AlternateExchange | string | no | The alternate exchange. An alternate exchange is used to receive messages that fail to be routed by the exchange |

### Creates an ApsaraMQ for RabbitMQ instance
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token |
| PaymentType | string | yes | The payment type. Valid values: |
| Period | integer | no | The subscription period. Unit: periodCycle |
| PeriodCycle | string | no | The unit of the subscription period. Valid values: |
| AutoRenew | string | no | The renewal method. Valid values: |
| AutoRenewPeriod | integer | no | The auto-renewal epoch. The unit is specified by the RenewalDurationUnit value. Default unit: month |
| RenewStatus | string | no | The renewal status. This parameter is equivalent to autoRenew. You only need to configure one of them. Valid values: |
| RenewalDurationUnit | string | no | The unit of the auto-renewal epoch. Valid values: |
| InstanceType | string | no | The instance type |
| ServerlessChargeType | string | no | The billing type of the serverless instance. Valid values: |
| InstanceName | string | no | The instance name. The name can be up to 64 characters in length |
| MaxPrivateTps | integer | no | The private network TPS. Unit: transactions per second |
| SupportEip | string | no | Specifies whether public network access is supported. Valid values: |
| MaxEipTps | integer | no | The peak public network TPS. Unit: TPS |
| QueueCapacity | integer | no | The number of queues. Unit: count |
| MaxConnections | integer | no | The maximum number of connections |
| StorageSize | integer | no | The message storage space. Unit: GB. Valid values: |
| SupportTracing | string | no | Specifies whether to enable the message tracing feature. Valid values: |
| TracingStorageTime | integer | no | The retention period for message traces. Unit: days. Valid values: |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| EncryptedInstance | string | no | This feature is available only for dedicated instances. Specifies whether to enable data storage encryption for the instance |
| KmsKeyId | string | no | This feature is available only for dedicated instances. This parameter is required when EncryptedInstance is set to true. The ID of the… |
| ProvisionedCapacity | integer | no | The provisioned TPS capacity for reserved + elastic instances |
| Edition | string | no | The deployment architecture of the serverless instance. Valid values: |
| Tags | string | no | The resource tags (JSON-encoded) |
| VpcId | string | yes | The VPC ID used to create a PrivateLink endpoint |
| VswitchIds | string | yes | The vSwitch IDs used to create a PrivateLink endpoint when creating an instance (JSON-encoded) |
| SecurityGroupId | string | yes | The security group ID used to create a PrivateLink endpoint |
| ListenerMode | string | no | Specifies whether to enable only the TLS-encrypted port for the instance. This parameter is supported only for dedicated reserved +… |
| AuthModel | string | no | The authentication mode. Default value: RAM authentication mode |
| ServerlessSwitch | string | no | The elastic switch |

### Creates an open-source username and password
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/create-open-source-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| UserName | string | yes | The username |
| Password | string | yes | The password of the static user to be created |
| Description | string | no | The remarks |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client. It must be… |

### Creates an open source permission
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/create-open-source-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserName | string | no | The username |
| Vhost | string | no | The vhost name |
| Configure | string | no | The regular expression for the configure permission |
| Write | string | no | The regular expression for the write permission |
| Read | string | no | The regular expression for the read permission |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |

### A queue is a buffer that stores messages. In ApsaraMQ for RabbitMQ, messages are sent to a specified…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/create-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance to which the queue belongs |
| VirtualHost | string | yes | The name of the vhost to which the queue belongs. The name can contain only letters, digits, hyphens (-), underscores (_), periods (.),… |
| QueueName | string | yes | The name of the queue to create. The queue name can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs… |
| AutoDeleteState | string | no | Specifies whether to automatically delete the queue. Valid values: true: The queue is automatically deleted after the last consumer… |
| ExclusiveState | string | no | Specifies whether the queue is an exclusive queue. Valid values: true: The queue is an exclusive queue. An exclusive queue can be used… |
| MessageTTL | integer | no | The time to live (TTL) of a message in the queue. A message expires if its retention time in the queue exceeds the configured TTL. The… |
| AutoExpireState | integer | no | The auto-expiration time for the queue. The queue is automatically deleted if it is not accessed within the specified time period. Unit:… |
| MaxLength | integer | no | This parameter is not supported in the current version. The maximum number of messages that can be stored in the queue. If this limit is… |
| DeadLetterExchange | string | no | The dead-letter exchange. This type of exchange is used to receive rejected messages. If a consumer rejects a message and the message is… |
| DeadLetterRoutingKey | string | no | The dead-letter routing key. The key can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#),… |
| MaximumPriority | integer | no | The priority of the queue. The recommended value is an integer from 1 to 10. This parameter is used for message priority. It is supported… |

### Creates a vhost. A vhost is used to logically isolate resources. Each vhost manages its own exchanges,…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/create-virtual-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The name of the vhost to create. The name must meet the following requirements: The name can contain only letters, digits, hyphens (-),… |

### Deletes a static username and password
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| UserName | string | yes | The static username to delete |
| CreateTimestamp | integer | no | The timestamp that indicates when the static username and password were created. Unit: milliseconds. Call the… |

### The DeleteBinding operation detaches a source exchange from a target queue or another exchange
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/delete-binding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| VirtualHost | string | yes | The vhost name |
| SourceExchange | string | yes | The name of the source exchange |
| DestinationName | string | yes | The name of the destination object |
| BindingType | string | yes | The type of the destination object. Valid values: QUEUE EXCHANGE |
| BindingKey | string | no | The binding key |

### Deletes an exchange
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/delete-exchange` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance that contains the exchange |
| VirtualHost | string | yes | The name of the vhost that contains the exchange |
| ExchangeName | string | yes | The name of the exchange to delete |

### Deletes an ApsaraMQ for RabbitMQ instance
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |

### Deletes the username and password of an open-source user
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/delete-open-source-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserName | string | no | The username |

### Deletes an open source permission
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/delete-open-source-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserName | string | yes | The username |
| Vhost | string | yes | The vhost name |

### Deletes a queue
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/delete-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| QueueName | string | yes | The queue name |
| VirtualHost | string | yes | The vhost name |

### Deletes a virtual host (vhost)
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/delete-virtual-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The name of the vhost to delete |

### Retrieves an ApsaraMQ for RabbitMQ instance
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/get-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |

### Queries the current and maximum numbers of vhosts, exchanges, and queues for a specified ApsaraMQ for…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/get-metadata-amount` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the ApsaraMQ for RabbitMQ instance |

### Lists the usernames and passwords for a specified ApsaraMQ for RabbitMQ instance
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The ID of the ApsaraMQ for RabbitMQ instance whose static usernames and passwords you want to list |

### Queries all bindings that are created in a vhost of a specified ApsaraMQ for RabbitMQ instance
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-bindings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The vhost name |
| NextToken | string | no | The token that marks the end of the current query. To retrieve the next page of results, pass the token that was returned in the previous… |
| MaxResults | integer | yes | The maximum number of entries to return. Valid values: 1 to 100 |

### Queries the exchanges or queues that are bound to a specified exchange
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-down-stream-bindings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance to which the exchange belongs |
| VirtualHost | string | yes | The name of the vhost to which the exchange belongs |
| ExchangeName | string | yes | The name of the exchange |
| NextToken | string | no | The token that is used to retrieve the next page of results. If this is your first call, or if you have retrieved all results, leave this… |
| MaxResults | integer | no | The maximum number of results to return |

### Queries the queues or other exchanges that are bound to a specified exchange
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-exchange-up-stream-bindings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The vhost name |
| ExchangeName | string | yes | The exchange name |
| NextToken | string | no | The token that marks the end of the current query. Pass this token in the next call to query the next page. This parameter is an empty… |
| MaxResults | integer | no | The maximum number of results to return |

### Lists all exchanges in a specified vhost of an instance
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-exchanges` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The name of the vhost |
| NextToken | string | no | The token for retrieving the next page of results. Set this parameter to the token value returned from the previous call. Omit this… |
| MaxResults | integer | no | The maximum number of results to return. Valid values: 1 to 100 |

### Queries the IP or VPC whitelist of an instance. This operation supports only new-architecture instances…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-instance-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the instance whose whitelist you want to query |
| whiteListType | integer | yes | The whitelist type. If WhiteListItem contains IP addresses, set WhiteListType to 2. If WhiteListItem contains VPC IDs, set WhiteListType… |

### Queries the list of ApsaraMQ for RabbitMQ instances and basic information about each instance in a specified…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| 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… |
| MaxResults | integer | yes | The maximum number of entries to return. We recommend that you set this parameter to a value between 1 and 100 |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |

### Lists open-source usernames and passwords
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-open-source-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| NextToken | string | no | The token that marks the end of the current query. This value is passed as a parameter in the next call to continue pagination. Set this… |
| MaxResults | integer | no | The maximum number of entries to return |

### Lists open source permissions
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-open-source-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserName | string | yes | The username |
| MaxResults | integer | no | The maximum number of results to return |
| NextToken | string | no | The token for the next query |

### Queries the online consumer clients of a specified queue
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-queue-consumers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The vhost name |
| Queue | string | yes | The queue name |
| NextToken | string | no | The token that marks the end of the current page of results. To retrieve the next page, include this token in the next request. If this is… |
| QueryCount | integer | no | The number of entries to return. If you do not set this parameter, the default value is 1. Valid values: 1 to 100 |

### Queries the exchanges that are bound to a specified queue
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-queue-up-stream-bindings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The vhost name |
| QueueName | string | yes | The queue name |
| NextToken | string | no | The token that marks the end of the current query. To retrieve the next page of results, pass this token in the next request. For the… |
| MaxResults | integer | no | The maximum number of results to return |

### Queries information about all queues in a specific vhost of a specified ApsaraMQ for RabbitMQ instance
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-queues` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| VirtualHost | string | yes | The name of the vhost |
| NextToken | string | no | The token that marks the end of the current query. This token is passed as a parameter in the next call to continue pagination. Set this… |
| MaxResults | integer | yes | The maximum number of results to return |

### Lists all vhosts in a specified ApsaraMQ for RabbitMQ instance
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/list-virtual-hosts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| NextToken | string | no | The token that is used to retrieve the next page of results. If the number of results exceeds the value of MaxResults, NextToken is… |
| MaxResults | integer | yes | The maximum number of results to return. Valid values: 1 to 100 |

### Deletes an IP or VPC whitelist entry for an instance. This operation supports only new-architecture…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/remove-instance-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the instance for which you want to delete a whitelist entry |
| whiteListItemId | integer | yes | The ID of the whitelist entry. You can call ListInstanceWhiteList to query whitelist entry IDs |
| whiteListType | integer | yes | The type of the whitelist. Valid values: 1: IP whitelist. 2: VPC ID whitelist. If the whitelist entry is an IP address, set WhiteListType… |

### Updates an ApsaraMQ for RabbitMQ instance to upgrade or downgrade its specifications
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/update-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| ModifyType | string | yes | The specification change type. Valid values: UPGRADE: upgrades the instance specifications. DOWNGRADE: downgrades the instance… |
| InstanceType | string | no | The instance type. Valid values for subscription instances: professional: Professional Edition. enterprise: Enterprise Edition. vip:… |
| ServerlessChargeType | string | no | The billing type of the pay-as-you-go (Serverless) instance. Valid values: onDemand: pay-as-you-go |
| MaxPrivateTps | integer | no | The private network TPS, in transactions per second |
| SupportEip | string | no | Specifies whether public network access is supported |
| MaxEipTps | integer | no | The peak public network TPS, in transactions per second |
| QueueCapacity | integer | no | The maximum number of queues |
| MaxConnections | integer | no | The maximum number of connections |
| StorageSize | integer | no | The message storage space |
| SupportTracing | string | no | Specifies whether to enable the message tracing feature |
| TracingStorageTime | integer | no | The retention period of message traces |
| ProvisionedCapacity | integer | no | The provisioned TPS capacity of the provisioned + elastic instance |
| Edition | string | no | The deployment architecture of the Serverless instance. Valid values: shared: shared architecture. This value applies to provisioned +… |

### An ApsaraMQ for RabbitMQ instance is named after its instance ID by default. You can change the name for…
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/update-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the ApsaraMQ for RabbitMQ instance |
| InstanceName | string | yes | The new name of the instance. The name can be any string of up to 64 characters |

### Update serverless switch
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/update-instance-serverless-switch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ServerlessSwitch | string | no | The serverless elastic capability. true (enabled): The maximum TPS of the instance is increased to the base TPS multiplied by a factor… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client and must be… |

### Updates the username and password for open-source access
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/update-open-source-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserName | string | yes | The username |
| Password | string | no | The account password |
| Description | string | no | The remarks |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent repeated submissions |

### Updates open source permissions
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/update-open-source-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserName | string | no | The username |
| Vhost | string | no | The vhost name |
| Configure | string | no | The regular expression for configure permissions |
| Write | string | no | The regular expression for write permissions |
| Read | string | no | The regular expression for read permissions |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### version
`POST https://apizie.tech/v1/cloud:aliyun-amqp-open/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://amqp-open.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-amqp-open/add-instance-white-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud MQ for RabbitMQ API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-amqp-open/add-instance-white-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud MQ for RabbitMQ API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud MQ for RabbitMQ itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud MQ for RabbitMQ API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-amqp-open.

### What is the status of the Alibaba Cloud MQ for RabbitMQ API?
Needs your own provider key (bring your own key)