Adding a Binding
Function
This API is used to add a binding.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
POST /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/exchanges/{exchange}/binding
|
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
|
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
Range N/A Default Value N/A |
|
destination_type |
Yes |
String |
Type of the binding target. The options are Exchange and Queue (RabbitMQ AMQP supports only Queue bindings). |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
source |
String |
Binding source. |
|
destination_type |
String |
Type of the binding target. The options are Exchange or Queue. |
|
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"
}
SDK Sample Code
The SDK sample code is as follows.
Binding test-exchange to a Queue target named mirror-queue with routing key routing_key_1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.rabbitmq.v2.region.RabbitMQRegion; import com.huaweicloud.sdk.rabbitmq.v2.*; import com.huaweicloud.sdk.rabbitmq.v2.model.*; public class CreateBindingSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); RabbitMQClient client = RabbitMQClient.newBuilder() .withCredential(auth) .withRegion(RabbitMQRegion.valueOf("<YOUR REGION>")) .build(); CreateBindingRequest request = new CreateBindingRequest(); request.withInstanceId("{instance_id}"); request.withVhost("{vhost}"); request.withExchange("{exchange}"); CreateBindingBody body = new CreateBindingBody(); body.withDestinationType("Queue"); body.withRoutingKey("routing_key_1"); body.withDestination("mirror-queue"); request.withBody(body); try { CreateBindingResponse response = client.createBinding(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Binding test-exchange to a Queue target named mirror-queue with routing key routing_key_1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrabbitmq.v2.region.rabbitmq_region import RabbitMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrabbitmq.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = RabbitMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RabbitMQRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateBindingRequest() request.instance_id = "{instance_id}" request.vhost = "{vhost}" request.exchange = "{exchange}" request.body = CreateBindingBody( destination_type="Queue", routing_key="routing_key_1", destination="mirror-queue" ) response = client.create_binding(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Binding test-exchange to a Queue target named mirror-queue with routing key routing_key_1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rabbitmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := rabbitmq.NewRabbitMQClient( rabbitmq.RabbitMQClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateBindingRequest{} request.InstanceId = "{instance_id}" request.Vhost = "{vhost}" request.Exchange = "{exchange}" request.Body = &model.CreateBindingBody{ DestinationType: "Queue", RoutingKey: "routing_key_1", Destination: "mirror-queue", } response, err := client.CreateBinding(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Successful |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot