Query RabbitMQ vhost Exchanges Using ListExchanges API - ApsaraMQ for RabbitMQ - Alibaba Cloud - ApsaraMQ for RabbitMQ

Lists all exchanges in a specified vhost of an 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

*Instance

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

None

amqp:ListExchange

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for RabbitMQ instance.	amqp-cn-7pp2mwbc****
VirtualHost	string	Yes	The name of the vhost.	test
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 parameter on your first call. If a subsequent call is required, set this parameter to the `NextToken` value returned from the previous call.	AAAANDQBYW1xcC1jbi03cHAybXdiY3AwMGEBdmhvc3QBAXNkZndhYWJhATE2NDkzMTM4OTU5NDIB4o3z1pPwWzk4aYuiRffi8R6-****
MaxResults	integer	No	The maximum number of results to return. Valid values: 1 to 100.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	FEBA5E0C-50D0-4FA6-A794-4901E5465***
Data	object	The returned data.
MaxResults	integer	The maximum number of entries returned.	1
NextToken	string	The token that marks the start of the next query. If this parameter is empty, no more data is available. If a value is returned, use the value as the `NextToken` value in the next call to continue the query.	AAAANDQBYW1xcC1jbi03cHAybXdiY3AwMGEBdmhvc3QBAXNkZndhYWJhATE2NDkzMTM4OTU5NDIB4o3z1pPwWzk4aYuiRffi8R6-****
Exchanges	array<object>	The exchanges.
	array<object>
AutoDeleteState	boolean	Indicates whether the exchange is an auto-delete exchange.	false
CreateTime	integer	The time when the exchange was created. The value is a UNIX timestamp in milliseconds.	1580886216000
Attributes	object	The attributes of the exchange. This parameter is not supported.	test
VHostName	string	The name of the vhost to which the exchange belongs.	test
Name	string	The name of the exchange.	amq.direct
ExchangeType	string	The type of the exchange.	DIRECT
Internal	boolean	Indicates whether the exchange is an internal exchange.

Examples

Success response

JSON format

{
  "RequestId": "FEBA5E0C-50D0-4FA6-A794-4901E5465***",
  "Data": {
    "MaxResults": 1,
    "NextToken": "AAAANDQBYW1xcC1jbi03cHAybXdiY3AwMGEBdmhvc3QBAXNkZndhYWJhATE2NDkzMTM4OTU5NDIB4o3z1pPwWzk4aYuiRffi8R6-****",
    "Exchanges": [
      {
        "AutoDeleteState": false,
        "CreateTime": 1580886216000,
        "Attributes": {
          "test": "test",
          "test2": 1
        },
        "VHostName": "test",
        "Name": "amq.direct",
        "ExchangeType": "DIRECT",
        "Internal": false
      }
    ]
  }
}

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.