Updated on 2024-08-08 GMT+08:00

Creating a Queue

Function

This API is used to create a queue.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues

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.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Queue name.

auto_delete

Yes

Boolean

Indicates whether to enable automatic deletion.

durable

No

Boolean

Indicates whether to enable data persistence (RabbitMQ AMQP does not have this field because data persistence is enabled by default).

dead_letter_exchange

No

String

Name of the dead letter exchange. Rejected and expired messages are re-sent to this exchange.

dead_letter_routing_key

No

String

Routing key of the dead letter exchange. The dead letter exchange sends dead letter messages to the queue with a matching routing key.

message_ttl

No

Long

Indicates for how long a message in this queue can be retained.

lazy_mode

No

String

To make this queue lazy, enter lazy. Lazy queues store as many messages as possible on disk to save memory. If this parameter is not set, messages are stored in memory to be delivered quickly. (RabbitMQ AMQP does not have this parameter because messages are stored on disk by default).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

Queue name.

auto_delete

Boolean

Indicates whether to enable automatic deletion.

durable

Boolean

Indicates whether to enable data persistence (RabbitMQ AMQP does not have this field because data persistence is enabled by default).

dead_letter_exchange

String

Name of the dead letter exchange. Rejected and expired messages are re-sent to this exchange.

dead_letter_routing_key

String

Routing key of the dead letter exchange. The dead letter exchange sends dead letter messages to the queue with a matching routing key.

message_ttl

Long

Indicates for how long a message in this queue can be retained.

lazy_mode

String

To make this queue lazy, enter lazy. Lazy queues store as many messages as possible on disk to save memory. If this parameter is not set, messages are stored in memory to be delivered quickly. (RabbitMQ AMQP does not have this parameter because messages are stored on disk by default).

Example Requests

Creating a queue

PUT https://{endpoint}/v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues

{
  "name" : "string",
  "auto_delete" : true,
  "durable" : true,
  "dead_letter_exchange" : "string",
  "dead_letter_routing_key" : "string",
  "message_ttl" : 6000,
  "lazy_mode" : "string"
}

Example Responses

Status code: 200

Successful

{
  "name" : "string",
  "auto_delete" : true,
  "durable" : true,
  "dead_letter_exchange" : "string",
  "dead_letter_routing_key" : "string",
  "message_ttl" : 60000,
  "lazy_mode" : "string"
}

SDK Sample Code

The SDK sample code is as follows.

Creating a queue

 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
56
57
58
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 CreateQueueSolution {

    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();
        CreateQueueRequest request = new CreateQueueRequest();
        request.withInstanceId("{instance_id}");
        request.withVhost("{vhost}");
        CreateQueueBody body = new CreateQueueBody();
        body.withLazyMode("string");
        body.withMessageTtl(6000L);
        body.withDeadLetterRoutingKey("string");
        body.withDeadLetterExchange("string");
        body.withDurable(true);
        body.withAutoDelete(true);
        body.withName("string");
        request.withBody(body);
        try {
            CreateQueueResponse response = client.createQueue(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());
        }
    }
}

Creating a queue

 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
# 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 = CreateQueueRequest()
        request.instance_id = "{instance_id}"
        request.vhost = "{vhost}"
        request.body = CreateQueueBody(
            lazy_mode="string",
            message_ttl=6000,
            dead_letter_routing_key="string",
            dead_letter_exchange="string",
            durable=True,
            auto_delete=True,
            name="string"
        )
        response = client.create_queue(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Creating a queue

 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
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.CreateQueueRequest{}
	request.InstanceId = "{instance_id}"
	request.Vhost = "{vhost}"
	lazyModeCreateQueueBody:= "string"
	messageTtlCreateQueueBody:= int64(6000)
	deadLetterRoutingKeyCreateQueueBody:= "string"
	deadLetterExchangeCreateQueueBody:= "string"
	durableCreateQueueBody:= true
	request.Body = &model.CreateQueueBody{
		LazyMode: &lazyModeCreateQueueBody,
		MessageTtl: &messageTtlCreateQueueBody,
		DeadLetterRoutingKey: &deadLetterRoutingKeyCreateQueueBody,
		DeadLetterExchange: &deadLetterExchangeCreateQueueBody,
		Durable: &durableCreateQueueBody,
		AutoDelete: true,
		Name: "string",
	}
	response, err := client.CreateQueue(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.