1. 接口描述
接口请求域名: trabbit.tencentcloudapi.com 。
创建RabbitMQ队列
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateRabbitMQServerlessQueue。 |
Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例Id 示例值:amqp-slrlpeddnr |
VirtualHost | 是 | String | VHost参数 示例值:testVhost |
QueueName | 是 | String | 队列名称 示例值:testQueue |
QueueType | 否 | String | 只支持 classic 示例值:classic |
Durable | 否 | Boolean | 持久标记,classic类型必传,quorum类型无需传入固定为true 示例值:true |
AutoDelete | 否 | Boolean | 自动清除,classic类型必传,quorum类型无需传入固定为false 示例值:false |
Remark | 否 | String | 备注 示例值:测试队列 |
MessageTTL | 否 | Integer | MessageTTL参数,classic类型专用 示例值:1000 |
AutoExpire | 否 | Integer | AutoExpire参数,单位为 ms,队列在指定时间内没有被使用,将会被删除 示例值:1000 |
MaxLength | 否 | Integer | MaxLength参数。队列可以容纳的最大条数。若超出上限,将根据 overview behavior 处理 示例值:1000 |
MaxLengthBytes | 否 | Integer | MaxLengthBytes参数。若超出上限,将根据 overview behavior 处理。 示例值:1000 |
DeliveryLimit | 否 | Integer | DeliveryLimit参数,quorum类型专用 示例值:1000 |
OverflowBehaviour | 否 | String | OverflowBehaviour参数,取值为drop-head, reject-publish或reject-publish-dlx 示例值:drop-head |
DeadLetterExchange | 否 | String | DeadLetterExchange参数。可将过期或被拒绝的消息投往指定的死信 exchange。 示例值:testDeadLetterExchange |
DeadLetterRoutingKey | 否 | String | DeadLetterRoutingKey参数。只能包含字母、数字、"."、"-","@","_" 示例值:testDeadLetterRoutingKey |
SingleActiveConsumer | 否 | Boolean | SingleActiveConsumer参数。若开启,需确保每次有且只有一个消费者从队列中消费 示例值:true |
MaximumPriority | 否 | Integer | MaximumPriority参数,classic类型专用 示例值:1000 |
LazyMode | 否 | Boolean | LazyMode参数,classic类型专用 示例值:true |
MasterLocator | 否 | String | MasterLocator参数,classic类型专用,取值为min-masters,client-local或random 示例值:testMasterLocator |
MaxInMemoryLength | 否 | Integer | MaxInMemoryLength参数,quorum类型专用。quorum 队列的内存中最大消息数量 示例值:1000 |
MaxInMemoryBytes | 否 | Integer | MaxInMemoryBytes参数,quorum类型专用。quorum 队列的内存中最大数总消息大小 示例值:1000 |
Node | 否 | String | Node参数,非必填,指定创建 queue 所在节点 示例值:rabbit@amqp-xxxxxxxx-1 |
DeadLetterStrategy | 否 | String | 仲裁队列死信一致性策略,at-most-once、at-least-once,默认是at-most-once 示例值:at-most-once |
QueueLeaderLocator | 否 | String | 仲裁队列的领导者选举策略,client-local、balanced,默认是client-local 示例值:client-local |
QuorumInitialGroupSize | 否 | Integer | 仲裁队列的初始副本组大小,默认3 示例值:3 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
QueueName | String | 队列名称 示例值:queue1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建RabbitMQ队列
创建RabbitMQ队列
输入示例
POST / HTTP/1.1
Host: trabbit.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRabbitMQServerlessQueue
<公共请求参数>
{
"InstanceId": "amqp-slmejnrgtz",
"VirtualHost": "vhost1",
"QueueName": "queue1",
"QueueType": "vhost1",
"Remark": "测试队列"
}
输出示例
{
"Response": {
"QueueName": "queue1",
"RequestId": "941a7f2b-26f7-413f-b91f-341678cd00f6"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidFilter | 无效的过滤器 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RegionError | 地域错误 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |