文档中心>API 中心

创建队列接口

最近更新时间:2024-03-12 01:18:42

我的收藏

1. 接口描述

接口请求域名: cmq.tencentcloudapi.com 。

创建队列接口

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateQueue。
Version String 公共参数,本接口取值:2019-03-04。
Region String 公共参数,详见产品支持的 地域列表
QueueName String 队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
MaxMsgHeapNum Integer 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。
PollingWaitSeconds Integer 消息接收长轮询等待时间。取值范围 0-30 秒,默认值 0。
VisibilityTimeout Integer 消息可见性超时。取值范围 1-43200 秒(即12小时内),默认值 30。
MaxMsgSize Integer 消息最大长度。取值范围 1024-65536 Byte(即1-64K),默认值 65536。
MsgRetentionSeconds Integer 消息保留周期。取值范围 60-1296000 秒(1min-15天),默认值 345600 (4 天)。
RewindSeconds Integer 队列是否开启回溯消息能力,该参数取值范围0-msgRetentionSeconds,即最大的回溯时间为消息在队列中的保留周期,0表示不开启。
Transaction Integer 1 表示事务队列,0 表示普通队列
FirstQueryInterval Integer 第一次回查间隔
MaxQueryCount Integer 最大回查次数
DeadLetterQueueName String 死信队列名称
Policy Integer 死信策略。0为消息被多次消费未删除,1为Time-To-Live过期
MaxReceiveCount Integer 最大接收次数 1-1000
MaxTimeToLive Integer policy为1时必选。最大未消费过期时间。范围300-43200,单位秒,需要小于消息最大保留时间msgRetentionSeconds
Trace Boolean 是否开启消息轨迹追踪,当不设置字段时,默认为不开启,该字段为true表示开启,为false表示不开启

3. 输出参数

参数名称 类型 描述
QueueId String 创建成功的queueId
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建队列

创建队列示例

输入示例

https://cmq.tencentcloudapi.com/?Action=CreateQueue
&QueueName=test
&<公共请求参数>

输出示例

{
    "Response": {
        "QueueId": "queue-ges05csc",
        "RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.TryLater 操作进行中,请稍后重试。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。