更新时间:2024-08-07 GMT+08:00

创建Queue

功能介绍

创建Queue。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID

vhost

String

Vhost名称

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

Queue名称

auto_delete

Boolean

是否自动删除

durable

Boolean

是否持久化(AMQP版本默认持久化,不涉及此字段)

dead_letter_exchange

String

死信Exchange名称,消息被拒绝或过期时将重新发布到该Exchange。

dead_letter_routing_key

String

死信Exchange的RoutingKey,死信Exchange会发送死信消息到绑定对应RoutingKey的Queue上。

message_ttl

Long

发布到Queue的消息在被丢弃之前可以存活多长时间

lazy_mode

String

若设置惰性队列,请输入lazy。惰性队列模式会在磁盘上存储尽可能多的消息以减少内存使用;若不设置,队列将消息存储在内存缓存以尽可能快地传递消息。(AMQP版本默认将消息存储到磁盘,不涉及此字段)

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

name

String

Queue名称

auto_delete

Boolean

是否自动删除

durable

Boolean

是否持久化(AMQP版本默认持久化,不涉及此字段)

dead_letter_exchange

String

死信Exchange名称,消息被拒绝或过期时将重新发布到该Exchange。

dead_letter_routing_key

String

死信Exchange的RoutingKey,死信Exchange会发送死信消息到绑定对应RoutingKey的Queue上。

message_ttl

Long

发布到Queue的消息在被丢弃之前可以存活多长时间

lazy_mode

String

若设置惰性队列,请输入lazy。惰性队列模式会在磁盘上存储尽可能多的消息以减少内存使用;若不设置,队列将消息存储在内存缓存以尽可能快地传递消息。(AMQP版本默认将消息存储到磁盘,不涉及此字段)

请求示例

创建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"
}

响应示例

状态码: 200

创建Queue成功

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

SDK代码示例

SDK代码示例如下。

创建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());
        }
    }
}

创建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)

创建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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

创建Queue成功

错误码

请参见错误码