調用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 Body為XML格式,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消息量為空時,針對該Queue的ReceiveMessage請求最長的等待時間。

    取值范圍: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 隊列不存在,請先創建隊列。