Creating an Exchange

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

View PDF

Function

This API is used to create an exchange.

Calling Method

For details, see Calling APIs.

URI

PUT /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.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Exchange name.
type	Yes	String	Type (direct, fanout, topic, or headers)
durable	No	Boolean	Indicates whether to enable data persistence.
auto_delete	Yes	Boolean	Indicates whether to enable automatic deletion.
internal	No	Boolean	Internal exchange.

Response Parameters

Status code: 200

**Table 3** Response body parameters
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

Creating an exchange

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

{
  "name" : "exchange_name_demo",
  "type" : "direct",
  "durable" : true,
  "auto_delete" : false,
  "internal" : false
}

Example Responses

Status code: 200

Successful

{
  "name" : "exchange_name_demo",
  "type" : "direct",
  "durable" : true,
  "auto_delete" : false,
  "internal" : false,
  "vhost" : "default"
}

Status Codes


Status Code	Description
200	Successful

Error Codes

See Error Codes.

Parent Topic: Exchange Management

Previous topic: Exchange Management

Next topic: Querying Exchanges

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel