Help Center/Distributed Message Service for RabbitMQ/API Reference/APIs V2 (Recommended)/Binding Management/Adding a Binding
Updated on 2025-12-29 GMT+08:00
View PDF

Adding a Binding

Function

This API is used to add a binding.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

vhost

Yes

String

Virtual host name. If the name contains a slash (/), replace it with __F_SLASH__. Otherwise, the calling fails. For example, if the virtual host name is /test, the input parameter is __F_SLASH__test.

exchange

Yes

String

Exchange name.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

destination

Yes

String

Name of a target exchange or queue.

routing_key

Yes

String

Definition

Binding key-value. This parameter informs the exchange of which queues or exchanges to deliver messages to.

Constraints

  • Cannot contain plus signs (+) or tildes (~).

  • Contains a maximum of 128 characters.

  • Cannot contain Chinese characters.

Range

N/A

Default Value

N/A

destination_type

Yes

String

Definition

Type of the binding target.

Constraints

The AMQP version only supports queue bindings.

Range

  • exchange

  • queue

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

source

String

Binding source.

destination_type

String

Definition

Type of the binding target.

Range

  • exchange

  • queue AMQP only supports queue bindings.

destination

String

Name of a target exchange or queue.

routing_key

String

Binding key-value. This parameter informs the exchange of which queues to deliver messages to.

Example Requests

Binding test-exchange to a Queue target named mirror-queue with routing key routing_key_1

POST /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/default/exchanges/test-exchange/binding

{
  "destination_type" : "Queue",
  "destination" : "mirror-queue",
  "routing_key" : "routing_key_1"
}

Example Responses

Status code: 200

Successful

{
  "source" : "exchange_name",
  "destination_type" : "Queue",
  "destination" : "queue_name",
  "routing_key" : "binding_key_demo"
}

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.

Parent Topic: Binding Management