接口协议
接口 | https://[endpoint].ctapi.ctyun.cn/v1/queue/create | ||
请求方式 | POST | ||
请求参数 | 是否必填 | 参数类型 | 说明 |
prodInstId | 是 | String | 实例ID |
vhost | 是 | String | vhost名称 |
name | 是 | String | 队列名称 |
durable | 否 | Boolean | 是否持久化 |
auto_delete | 否 | Boolean | 是否自动删除 |
node | 否 | String | 选择存储数据的节点 |
arguments | 否 | String | |
响应参数 | 参数类型 | 描述 | |
statusCode | String | 接口系统层面状态码。成功：800，失败：900 | |
message | String | 描述状态 | |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 | |
其中，arguments请参照下表，格式：{x-message-ttl: 123, x-overflow: "reject-publish", x-queue-mode: "lazy",…}
参数名 | 参数类型 | 说明 |
x-message-ttl | Integer | 消息过期时间：number型(单位:ms) |
x-expires | Integer | 队列过期时间，过期后队列自动删除：number型(单位:ms) |
x-max-length | Integer | 队列能保存的最大消息数：number型(单位:个) |
x-max-length-bytes | Integer | 队列能保存的最大消息量：number型(单位:字节) |
x-overflow | 单选（drop-head\reject-publish） | 超过队列的最大设定值后消息接收策略 drop-head：删除头部消息,一般就是最早发送的消息，保证队列可用。 reject-publish：拒绝接受新的消息，保证消息不丢失。 |
x-dead-letter-exchangeh | String | 死信交换器名称 |
x-dead-letter-routing-key | String | 死信路由键 |
x-max-priority | Integer | 队列最大优先级：要开启消息的优先级，必须设置消息所在队列的优先级 |
x-queue-mode | 单选（default\lazy） | 队列惰性模式：default：默认值，普通队列。 lazy：惰性队列，尽可能将消息存到磁盘中，会引起I/O操作比较多，内存消耗极少。（有大量堆积的持久化消息建议使用） |
x-queue-master-locator | 单选（client-local\min-masters\random ） | 队列保存位置：client-local：队列创建时所用连接的节点。 min-masters： 集群中节点主数量最少的节点。random：由rabbitmq服务器随机指定一个节点。 |
请求示例
`POST https://[endpoint].ctapi.ctyun.cn/v1/queue/create`
返回示例
（1）成功响应示例
{
"returnObj": {"data": null },
"message": "success",
"statusCode": "800"
}（2）失败响应示例
{
"returnObj": { "data": "{\"error\":\"not_found\",\"reason\":\"vhost_not_found\"}"},
"message": "404 Not Found",
"statusCode": "900"
}