ListExchangeUpStreamBindings - ApsaraMQ for RabbitMQ - Alibaba Cloud Documentation Center

Queries the queues or other exchanges that are bound to a specified exchange.

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

*Instance

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

None

amqp:ListExchange
amqp:ListQueue

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
ExchangeName	string	Yes	The exchange name.	test
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 string for the first query or when the last page is returned.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The maximum number of results to return.	1

Response elements

Element	Type	Description	Example
	object
Code	integer	The return code. A value of 200 indicates that the call is successful.	200
Message	string	The returned message.	operation success
RequestId	string	The request ID.	2DCCCE88-BC82-4A4F-AF5E-9A759672B***
Success	boolean	Indicates whether the call was successful.	true
Data	object	The returned data.
MaxResults	integer	The maximum number of results returned.	1
NextToken	string	The token that indicates the position where the current query ends. An empty value indicates that all data has been read.	caebacccb2be03f84eb48b699f0a****
Bindings	array<object>	The bindings.
	object
SourceExchange	string	The name of the source exchange.	dle
Argument	string	The x-match property. Valid values: all: The default value. All key-value pairs in the message header must match. any: At least one key-value pair in the message header must match. This parameter is valid only for headers exchanges. It is invalid for other types of exchanges.	all
BindingKey	string	The binding key. If the source exchange is not a topic exchange: The key can contain only letters, digits, hyphens (-), underscores (_), periods (.), forward slashes (/), and at signs (@). The key must be 1 to 255 characters in length. If the source exchange is a topic exchange: The key can contain letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slashes (/), and at signs (@). The key cannot start or end with a period (.). A number sign (#) or an asterisk (*) must be preceded by a period if it is not at the start of the key. It must be followed by a period if it is not at the end of the key. The key must be 1 to 255 characters in length.	amq.dle.test
BindingType	string	The type of the destination object. Valid values: QUEUE EXCHANGE	EXCHANGE
DestinationName	string	The destination name.	test

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "operation success",
  "RequestId": "2DCCCE88-BC82-4A4F-AF5E-9A759672B***",
  "Success": true,
  "Data": {
    "MaxResults": 1,
    "NextToken": "caebacccb2be03f84eb48b699f0a****",
    "Bindings": [
      {
        "SourceExchange": "dle",
        "Argument": "all",
        "BindingKey": "amq.dle.test",
        "BindingType": "EXCHANGE",
        "DestinationName": "test"
      }
    ]
  }
}

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.