全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 阿里云办公 培训与认证 物联网
消息服务

设置队列属性

更新时间:2017-06-07 13:26:11   分享:   

基本信息

Name Value
API SetQueueAttributes
RAM授权操作 mns:SetQueueAttributes
资源 acs:mns:$region:$accountid:/queues/$queueName

描述

该接口用于修改消息队列的属性。

Request

Request的构造主要由以下几个部分组成:

  • 请求行

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

  • URI参数

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

  • 特有Request Header

    无,请参考 调用方式/公共参数

  • Request Body

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

参数名称 说明 参数值
DelaySeconds 发送到该 Queue 的所有消息默认将以 DelaySeconds 参数指定的秒数延后可被消费,单位为秒。 0-604800秒(7天)范围内某个整数值
MaximumMessageSize 发送到该 Queue 的消息体的最大长度,单位为 Byte。 1024(1KB)-65536(64KB)范围内的某个整数值
MessageRetentionPeriod 消息在该 Queue 中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除,单位为秒。 60 (1分钟)-1296000 (15 天)范围内某个整数值
VisibilityTimeout 消息从该 Queue 中取出后从 Active 状态变成 Inactive 状态后的持续时间,单位为秒。 1-43200(12小时)范围内的某个值整数值
PollingWaitSeconds 当Queue消息量为空时,针对该 Queue 的 ReceiveMessage 请求最长的等待时间,单位为秒。 0-30秒范围内的某个整数值
LoggingEnabled 是否开启日志管理功能,True表示启用,False表示停用 True/False

Response

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

  • HTTP Status Code

    HTTP/1.1 204 No Content

  • 特有Response Header

    无,请参考 调用方式/公共参数

  • Response Body

Special Error

错误代码 错误消息 状态码
InvalidArgument The value of Element should between Low and High seconds/bytes. 400
QueueNotExist The queue name you provided is not exist. 404

请求示例:

  1. PUT /queues/$queueName?Metaoverride=true HTTP/1.1
  2. Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
  3. Date: Wed, 08 Mar 2012 12:00:00 GMT
  4. x-mns-version: 2015-06-06
  5. Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
  6. <?xml version="1.0" encoding="UTF-8"?>
  7. <Queue xmlns="http://mns.aliyuncs.com/doc/v1/">
  8. <VisibilityTimeout >60</VisibilityTimeout>
  9. <MaximumMessageSize>1024</MaximumMessageSize>
  10. <MessageRetentionPeriod>120</MessageRetentionPeriod>
  11. <DelaySeconds>30</DelaySeconds>
  12. <LoggingEnabled>True</LoggingEnabled>
  13. </Queue>

返回示例:

  1. HTTP/1.1 204 No Content
  2. x-mns-request-id:512B2A634403E52B1956133E
  3. x-mns-version: 2015-06-06
本文导读目录
本文导读目录
以上内容是否对您有帮助?