获取队列属性

最近更新时间:2019-08-13 11:45:36

接口描述

本接口(GetQueueAttributes)用于获取某个已创建队列的属性。返回属性除了创建队列时设置的可设置属性外,还可以取到队列创建时间,最后一次修改队列属性时间,以及队列中消息的统计数据(近似值)。

  • 外网接口请求域名:https://cmq-queue-{$region}.api.qcloud.com
  • 内网接口请求域名:http://cmq-queue-{$region}.api.tencentyun.com

上述域名中的{$region}需用具体地域替换:gz(广州)、sh(上海)、bj(北京)、shjr(上海金融)、szjr(深圳金融)、hk(中国香港)、cd(成都)、ca(北美)、usw(美西)、sg(新加坡)。公共参数中的 region 值要与域名的 region 值保持一致,如果出现不一致的情况,以域名的 region 值为准,将请求发往域名 region 所指定的地域。

注意:

任何时候(包括内测期间),如果使用外网域名产生公网下行流量,都会收取流量费用。 所以强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 是否必选 类型 描述
queueName String 队列名字,在单个地域同一帐号下唯一。 队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。

输出参数

参数名称 类型 描述
code Int 0:表示成功,4440:队列不存在,其他返回值的含义可以参考 错误码
message String 错误提示信息。
requestId String 服务器生成的请求 ID。出现服务器内部错误时,用户可提交此 ID 给后台定位问题。
maxMsgHeapNum Int 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000
pollingWaitSeconds Int 消息接收长轮询等待时间。取值范围0 - 30秒,默认值0。
visibilityTimeout Int 消息可见性超时。取值范围1 - 43200秒(即12小时内),默认值30。
maxMsgSize Int 消息最大长度。取值范围1024 - 1048576 Byte(即1K - 1024K),默认值65536。
msgRetentionSeconds Int 消息保留周期。取值范围60-1296000秒(1min-15天),默认值345600秒(4 天)。
createTime Int 队列的创建时间。返回 Unix 时间戳,精确到秒。
lastModifyTime Int 最后一次修改队列属性的时间。返回 Unix 时间戳,精确到秒。
activeMsgNum Int 在队列中处于 Active 状态(不处于被消费状态)的消息总数,为近似值。
inactiveMsgNum Int 在队列中处于 Inactive 状态(正处于被消费状态)的消息总数,为近似值。
rewindSeconds Int 回溯队列的消息回溯时间最大值,取值范围0 - 43200秒,0表示不开启消息回溯。
rewindmsgNum Int 已调用 DelMsg 接口删除,但还在回溯保留时间内的消息数量。
minMsgTime Int 消息最小未消费时间,单位为秒。
queueName String 消息队列名字。
queueId String 消息队列ID。
createUin Int 创建者Uin。
Bps Int 带宽限制。
qps Int 每秒钟生产消息条数的限制,消费消息的大小是该值的1.1倍。
tags Array 关联的标签。

示例

输入:

 https://domain/v2/index.php?Action=GetQueueAttributes
 &queueName=test-queue-123
 &<公共请求参数>

输出:

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "requestId": "1661914201",
    "maxMsgHeapNum": 100000000,
    "pollingWaitSeconds": 3,
    "visibilityTimeout": 43200,
    "maxMsgSize": 65536,
    "msgRetentionSeconds": 86400,
    "rewindSeconds": 86400,
    "delayMsgNum": 0,
    "minMsgTime": 1564626851,
    "rewindMsgNum": 0,
    "inactiveMsgNum": 0,
    "activeMsgNum": 2,
    "lastModifyTime": 1563877026,
    "createTime": 1563877026,
    "queueName": "dns",
    "queueId": "queue-aiav4lys",
    "createUin": 100010439978,
    "Bps": 52428800,
    "qps": 5000,
    "tags": []
}