1.接口协议：
接口 | https://[endpoint].ctapi.ctyun.cn/v1/queue/query | |||
请求方式 | GET | |||
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
prodInstId | 是 | String | 实例ID | |
vhost | 否 | String | vhost名称 | |
name | 否 | String | 队列名称 | |
响应参数 | 参数类型 | 描述 | ||
statusCode | String | 接口系统层面状态码。成功：800，失败：900 | ||
message | String | 描述状态 | ||
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 | ||
返回值
参数名 | 参数类型 | 说明 |
x-message-ttl | Integer | 消息过期时间：number型(单位:ms) |
x-expires | Integer | 队列过期时间，过期后队列自动删除：number型(单位:ms) |
x-max-length | Integer | 队列能保存的最大消息数：number型(单位:个) |
x-max-length-bytes | Integer | 队列能保存的最大消息量：number型(单位:字节) |
x-overflow | 单选（drophead\reject-publish） | a 超过队列的最大设定值后消息接收策略 drop-head：删除头部消息,一般就是最早发送的消息，保证队列可用。 reject-publish：拒绝接受新的消息，保证消息不丢失。 |
x-dead-letter-exchangeh | String | 死信交换器名称 |
x-dead-letter-routing-key | String | 死信路由键 |
x-max-priority | Integer | 队列最大优先级：要开启消息的优先级，必须设置消息所在队列的优先级 |
x-queue-mode | 单选（default\lazy） | 队列惰性模式：default：默认值，普通队列。 lazy：惰性队列，尽可能将消息存到磁盘中，会引起I/O操作比较多，内存消耗极少。（有大量堆积的持久化消息建议使用） |
x-queue-master-locator | 单选（client-local\min-masters\random ） | 队列保存位置：client-local：队列创建时所用连接的节点。 min-masters： 集群中节点主数量最少的节点。random：由rabbitmq服务器随机指定一个节点。 |
2.请求示例：
`GET https://[endpoint].ctapi.ctyun.cn/v1/queue/query`
3.返回示例：
成功响应示例
{
"returnObj":{
"data":{
"consumer_details":[
],
"arguments":{
},
"auto_delete":false,
"backing_queue_status":{
"avg_ack_egress_rate":0,
"avg_ack_ingress_rate":0,
"avg_egress_rate":0,
"avg_ingress_rate":0,
"delta":[
"delta",
"undefined",
0,
0,
"undefined"
],
"len":0,
"mode":"default",
"next_seq_id":0,
"q1":0,
"q2":0,
"q3":0,
"q4":0,
"target_ram_count":"infinity"
},
"consumer_utilisation":null,
"consumers":0,
"deliveries":[
],
"durable":true,
"effective_policy_definition":[
],
"exclusive":false,
"exclusive_consumer_tag":null,
"garbage_collection":{
"fullsweep_after":65535,
"max_heap_size":0,
"min_bin_vheap_size":46422,
"min_heap_size":233,
"minor_gcs":5
},
"head_message_timestamp":null,
"idle_since":"2019-10-17 12:32:08",
"incoming":[
],
"memory":16908,
"message_bytes":0,
"message_bytes_paged_out":0,
"message_bytes_persistent":0,
"message_bytes_ram":0,
"message_bytes_ready":0,
"message_bytes_unacknowledged":0,
"messages":0,
"messages_details":{
"rate":0
},
"messages_paged_out":0,
"messages_persistent":0,
"messages_ram":0,
"messages_ready":0,
"messages_ready_details":{
"rate":0
},
"messages_ready_ram":0,
"messages_unacknowledged":0,
"messages_unacknowledged_details":{
"rate":0
},
"messages_unacknowledged_ram":0,
"name":"queue",
"node":"rabbit@node19216890135",
"operator_policy":null,
"policy":null,
"recoverable_slaves":null,
"reductions":29757,
"reductions_details":{
"rate":0
},
"state":"running",
"vhost":"/"
}
},
"message":"success",
"statusCode":"800"
}
失败响应示例
{
"returnObj":{
},
"message":"...",
"statusCode":"900"
}