SetQueueAttributes

调用SetQueueAttributes接口修改队列属性。

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见授权策略和示例

Name

Value

API

SetQueueAttributes

RAM授权操作

mns:SetQueueAttributes

资源

acs:mns:$region:$accountid:/queues/$queueName

请求消息

请求消息由请求行、HTTP头和消息体三部分组成:

  • 请求行

    PUT /queues/$queueName?metaoverride=true HTTP/1.1

  • URI参数

    metaoverride=true将会修改消息队列的属性。

  • 特有Request Header

    无。

  • Request Body

    Request BodyXML格式,XML中包含创建Queue的属性,这些属性都为可选属性。

    参数名称

    类型

    是否必选

    示例值

    描述

    DelaySeconds

    Integer

    0

    发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费。

    取值范围:0~604800,单位为秒。

    默认值:0。

    MaximumMessageSize

    Integer

    1024

    发送到该Queue的消息体的最大长度。

    取值范围:1024~65536,单位为Byte。

    默认值:65536。

    MessageRetentionPeriod

    Integer

    120

    消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出,都将被删除。

    取值范围:60~604800,单位为秒。

    默认值:345600。

    VisibilityTimeout

    Integer

    60

    消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。

    取值范围:1~43200,单位为秒。

    默认值:30。

    PollingWaitSeconds

    Integer

    0

    Queue消息量为空时,针对该QueueReceiveMessage请求的最长等待时间。

    取值范围:0~30,单位为秒。

    默认值:0。

    LoggingEnabled

    Boolean

    True

    是否开启日志管理功能。

    取值说明如下:

    • True:启用。

    • False:停用。

    默认值:False。

    如果您使用Terraform管理alicloud_message_service_queue,请将API中的参数LoggingEnabled替换为EnableLogging

返回消息

返回消息由返回状态行、HTTP头和消息体三部分组成:

  • HTTP Status Code

    HTTP/1.1 204 No Content

  • 特有Response Header

    无。

  • Response Body

    无。

示例

请求示例:

    PUT /queues/$queueName?Metaoverride=true HTTP/1.1
    Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
    Date: Wed, 08 Mar 2012 12:00:00 GMT
    x-mns-version: 2015-06-06
    Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAM****

    <?xml version="1.0" encoding="UTF-8"?>
    <Queue xmlns="http://mns.aliyuncs.com/doc/v1/">
        <VisibilityTimeout >60</VisibilityTimeout>
        <MaximumMessageSize>1024</MaximumMessageSize>
        <MessageRetentionPeriod>120</MessageRetentionPeriod>
        <DelaySeconds>30</DelaySeconds>
        <LoggingEnabled>True</LoggingEnabled>
    </Queue>          

返回示例:

    HTTP/1.1 204 No Content
    x-mns-request-id:512B2A634403E52B1956****
    x-mns-version: 2015-06-06            

错误码

错误码

错误信息

HTTP状态码

描述内容

InvalidArgument

The value of Element should between Low and High seconds/bytes.

400

参数取值不合法,请确保参数的取值包含在取值范围内。

QueueNotExist

The queue name you provided is not exist.

404

队列不存在,请先创建队列。