查询指定Queue详情
功能介绍
查询指定Queue详情。
调用方法
请参见如何调用API。
URI
GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues/{queue}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID |
vhost |
是 |
String |
所属Vhost名称 |
queue |
是 |
String |
Queue名称 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
vhost |
String |
Queue所属Vhost名称 |
name |
String |
Queue名称 |
durable |
Boolean |
是否持久化 |
auto_delete |
Boolean |
是否自动删除 |
messages |
Integer |
待消费消息数 |
consumers |
Integer |
连接的消费者数 |
policy |
String |
策略(AMQP版本不支持policy,不涉及此参数) |
arguments |
QueueArguments object |
Queue参数,如果未配置则不返回。 |
consumer_details |
Array of ConsumerDetails objects |
订阅该Queue的消费者信息。 |
queue_bindings |
Array of BindingsDetails objects |
以此Queue为目标的绑定信息列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
x-message-ttl |
Long |
消息过期时间,发布到Queue的消息在被丢弃之前可以存活多长时间。 |
x-dead-letter-exchange |
String |
死信Exchange名称,消息被拒绝或过期时将重新发布到该Exchange。 |
x-dead-letter-routing-key |
String |
死信的RoutingKey,死信Exchange会发送死信消息到绑定对应RoutingKey的Queue上。 |
x-queue-mode |
String |
惰性队列(AMQP版本默认持久化所有消息,不涉及此参数) |
参数 |
参数类型 |
描述 |
---|---|---|
consumer_tag |
String |
消费者标识 |
channel_details |
ChannelDetails object |
消费者连接信息 |
ack_required |
Boolean |
消费者客户端是否设置手动ack |
prefetch_count |
Integer |
消费者客户端预取值 |
请求示例
查询指定Queue详情
GET https://{endpoint}/v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/queues?offset=0&limit=10
响应示例
无
SDK代码示例
SDK代码示例如下。
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 |
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 ShowQueueDetailsSolution { 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(); ShowQueueDetailsRequest request = new ShowQueueDetailsRequest(); request.withInstanceId("{instance_id}"); request.withVhost("{vhost}"); request.withQueue("{queue}"); try { ShowQueueDetailsResponse response = client.showQueueDetails(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()); } } } |
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 |
# 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 = ShowQueueDetailsRequest() request.instance_id = "{instance_id}" request.vhost = "{vhost}" request.queue = "{queue}" response = client.show_queue_details(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.ShowQueueDetailsRequest{} request.InstanceId = "{instance_id}" request.Vhost = "{vhost}" request.Queue = "{queue}" response, err := client.ShowQueueDetails(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询指定Queue详情成功 |
错误码
请参见错误码。