调用CreateQueue接口创建一个新的队列。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见授权策略和示例。
Name | Value |
---|---|
API | CreateQueue |
RAM授权操作 | mns:CreateQueue |
资源 | acs:mns:$region:$accountid:/queues/$queueName |
使用说明
- 队列名称为不超过120个字符的字符串,必须以字母或数字为首字符,剩余部分可以包含字母、数字和短划线(-)。
- 队列实例默认上限为1000个,如有特殊需求可提交工单提高队列实例上限值。
请求消息
请求消息由请求行、HTTP头和消息体三部分组成:
- 请求行
PUT /queues/$queueName HTTP/1.1
- 特有Request Header
无。
- Request Body
Request Body为XML格式,XML中包含创建队列的属性,这些属性都为可选属性。
属性列表如下:
参数名称 类型 是否必选 示例值 描述 DelaySeconds Integer 否 0 发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费。 取值范围:0~604800,单位为秒。
默认值:0。
MaximumMessageSize Integer 否 65536 发送到该Queue的消息体的最大长度。 取值范围:1024~65536,单位为Byte。
默认值:65536。
MessageRetentionPeriod Integer 否 345600 消息在该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:停用。
说明- 只要Queue设置了
PollingWaitSeconds
,针对该Queue的所有(Batch)ReceiveMessage请求在队列无消息时,都将默认进入到Polling等待状态(即长轮询)。如果在PollingWaitSeconds时间内一直保持无消息,则返回MessageNotExist;如果在PollingWaitSeconds时间内有新的消息进入到Queue中,则唤醒相应的ReceiveMessage请求,返回消息。 - 进入长轮询后,建议您降低长轮询的并发数。目前MNS服务端会根据用户的长轮询数量、长轮询等待时间、访问IP数量等因素动态设置长轮询防攻击并发上限值。当队列无消息时,超过长轮询上限值的请求将无法进入到监听状态,并直接返回404 MessageNotExist(按请求量正常计费)。如果您有临时提升长轮询上限值的需求,请及时提交工单,避免产生不必要的费用支出。
- 如果您使用Terraform管理alicloud_message_service_queue,请将API中的参数LoggingEnabled替换为EnableLogging。
返回消息
返回消息由返回状态行、HTTP头和消息体三部分组成:
- HTTP Status Code
HTTP/1.1 201 Created
同一个用户名下的队列不能重名,当出现创建重名队列时,如果创建队列的属性与已经存在的队列属性相同,返回204(No Content);否则返回409(Conflict)。
- 特有Response Header
参数名称 类型 示例值 描述 Location String http://$AccountId.mns.cn-hangzhou.aliyuncs.com/queues/$queueName 返回创建的QueueURL,格式如下: http://$AccountId.mns.<Region>.aliyuncs.com/queues/$queueName
。 - Response Body
无。
示例
请求示例:
PUT /queues/$queueName 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>65536</MaximumMessageSize>
<MessageRetentionPeriod>345600</MessageRetentionPeriod>
<LoggingEnabled>True</LoggingEnabled>
</Queue>
返回示例:
HTTP/1.1 201 Created
x-mns-request-id:512B2A634403E52B1956****
x-mns-version: 2015-06-06
Location: http://$AccountId.mns.cn-hangzhou.aliyuncs.com/queues/$queueName
错误码
错误码 | 错误信息 | HTTP状态码 | 描述内容 |
---|---|---|---|
QueueAlreadyExist | The queue you want to create is already exist. | 409 | 同名队列已存在,且请求属性与原有订阅属性不同。 |
InvalidArgument | The value of Element should between Low and High seconds/bytes. | 400 | 过滤标签长度不符合要求,请根据提示调整。 |
QueueNumExceededLimit | The number of the queues you created has excceeded the limit. | 400 | 创建的队列数超过最大限制数1000条。 |