ListBindings - ApsaraMQ for RabbitMQ - Alibaba Cloud Documentation Center

Queries all bindings that are created in a vhost of a specified 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

list

*All Resource

*

None

amqp:ListQueue
amqp:ListExchange

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for RabbitMQ instance.	1880770869023***
VirtualHost	string	Yes	The vhost name.	Test
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 call. For the first call or if the last page is returned, the value of this parameter is an empty string.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	Yes	The maximum number of entries to return. Valid values: 1 to 100	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	E0A71208-3E87-4732-81CC-B18E0B4B1***
Data	object	The returned data.
MaxResults	integer	The maximum number of entries returned for the current request.	1
NextToken	string	The position where the current query ends. An empty value indicates that all data is returned.	caebacccb2be03f84eb48b699f0a****
Bindings	array<object>	The list of bindings.
	object
SourceExchange	string	The name of the source exchange.	test
Argument	string	The x-match property. Valid values: all: The default value. All key-value pairs of the message header must match. any: At least one key-value pair of the message header must match. This parameter is valid only for headers exchanges.	all
BindingKey	string	The binding key. If the source exchange is not a topic exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), forward slashes (/), and at signs (@). The binding key must be 1 to 255 characters in length. If the source exchange is a topic exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), asterisks (), periods (.), number signs (#), forward slashes (/), and at signs (@). The binding key cannot start or end with a period (.). If the key starts with a number sign (#) or an asterisk (), it must be followed by a period (.). If the key ends with a number sign (#) or an asterisk (), it must be preceded by a period (.). If a number sign (#) or an asterisk () is in the middle of the key, it must be both preceded and followed by a period (.). The binding key must be 1 to 255 characters in length.	amq.test
BindingType	string	The type of the destination object. Valid values: QUEUE EXCHANGE	QUEUE
DestinationName	string	The name of the destination.	QueueTest

Examples

Success response

JSON format

{
  "RequestId": "E0A71208-3E87-4732-81CC-B18E0B4B1***",
  "Data": {
    "MaxResults": 1,
    "NextToken": "caebacccb2be03f84eb48b699f0a****",
    "Bindings": [
      {
        "SourceExchange": "test",
        "Argument": "all",
        "BindingKey": "amq.test",
        "BindingType": "QUEUE",
        "DestinationName": "QueueTest"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InstanceIdNotExist	The instance resource does not exist.
404	InstanceNotExist	The instance resource does not exist.	The instance resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.