修改队列属性

最近更新时间:2019-08-26 15:29:45

接口描述

本接口(SetQueueAttributes)用于修改消息队列的属性。

  • 外网接口请求域名: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个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
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 - 1048576Byte(即1K - 1024K),默认值65536。
msgRetentionSeconds Int 消息保留周期。取值范围60 - 1296000秒(1min - 15天),默认值345600(4天)。
rewindSeconds Int 消息最长回溯时间,取值范围0 - msgRetentionSeconds,消息的最大回溯之间为消息在队列中的保存周期,0表示不开启消息回溯。

输出参数

参数名称 类型 描述
code Int 0:表示成功,4440:队列不存在,其他返回值的含义可以参考 错误码
message String 错误提示信息。
requestId String 服务器生成的请求 ID。出现服务器内部错误时,用户可提交此 ID 给后台定位问题。
maxMsgHeapNum Int 更改后的最大堆积消息数。
pollingWaitSeconds Int 更改后的消息接收长轮询等待时间。
visibilityTimeout Int 更改后的消息可见性超时。
maxMsgSize Int 更改后的消息最大长度。
msgRetentionSeconds Int 更改后的消息生命周期。
rewindSeconds Int 更改后的最长消息回溯时间。

示例

输入:

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

输出:

{
"code" : 0,
"message" : "",
"requestId":"14534664555",
"queueId":"queue-ajksdfasdowe",
"maxMsgHeapNum":10000000,
"pollingWaitSeconds":20,
"visibilityTimeout":0,
"maxMsgSize":65536,
"msgRetentionSeconds":345600
}