Querying Exchanges

Updated on 2025-03-26 GMT+08:00

View PDF

Function

This API is used to query exchanges.

Calling Method

For details, see Calling APIs.

URI

GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/exchanges

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.
vhost	Yes	String	Virtual host name.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
limit	No	Integer	Number of records on each page. Value range: 0–50. The default value is 10.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
size	Integer	Number of displayed records.
total	Integer	Total number of results in a query.
items	Array of ExchangeDetails objects	Details of an exchange.

**Table 4** ExchangeDetails
Parameter	Type	Description
durable	Boolean	Indicates whether data persistence is enabled.
default	Boolean	Indicates whether the exchange is default.
internal	Boolean	Indicates whether the exchange is internal.
name	String	Exchange name.
auto_delete	Boolean	Indicates whether automatic deletion is enabled.
type	String	Exchange type.
vhost	String	Virtual host.

Example Requests

Querying exchanges

GET /v2/rabbitmq/{project_id}/instances/{instance_id}/exchanges?offset=0&limit=10

Example Responses

Status code: 200

Successful

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "durable" : true,
    "default" : false,
    "internal" : false,
    "name" : "default",
    "auto_delete" : false,
    "type" : "direct"
  } ]
}