1. 接口描述
接口请求域名： cmq.tencentcloudapi.com 。
枚举队列列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeQueueDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2019-03-04。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TagKey | 否 | String | 标签搜索 示例值：tag |
| Limit | 否 | Integer | 分页时本页获取队列的个数，如果不传递该参数，则该参数默认为20，最大值为50。 示例值：20 |
| QueueName | 否 | String | 精确匹配QueueName 示例值：test |
| Filters.N | 否 | Array of Filter | 筛选参数，目前支持QueueName筛选，且仅支持一个关键字 示例值：name |
| Offset | 否 | Integer | 分页时本页获取队列列表的起始位置。如果填写了该值，必须也要填写 limit 。该值缺省时，后台取默认值 0 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总队列数。 示例值：20 |
| QueueSet | Array of QueueSet | 队列详情列表。 示例值：[] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取队列列表
输入示例
https://cmq.tencentcloudapi.com/?Action=DescribeQueueDetail
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 4,
"QueueSet": [
{
"Tags": [],
"QueueId": "queue-kc7m75to",
"QueueName": "test",
"CreateUin": 20548499,
"Qps": 5000,
"Bps": 52428800,
"MaxDelaySeconds": 3600,
"MaxMsgHeapNum": 100000000,
"PollingWaitSeconds": 0,
"MsgRetentionSeconds": 345600,
"VisibilityTimeout": 30,
"MaxMsgSize": 65536,
"RewindSeconds": 0,
"CreateTime": 1581471003,
"LastModifyTime": 1581471003,
"Transaction": null,
"DeadLetterSource": [],
"DeadLetterPolicy": {
"DeadLetterQueue": "queue-0v0y40j4",
"DeadLetterQueueName": "test123",
"Policy": 0,
"MaxReceiveCount": 1,
"MaxTimeToLive": null
},
"TransactionPolicy": null,
"ActiveMsgNum": 0,
"InactiveMsgNum": 0,
"DelayMsgNum": 0,
"RewindMsgNum": 0,
"MinMsgTime": 1582015467
},
{
"Tags": [],
"QueueId": "queue-0v0y40j4",
"QueueName": "test123",
"CreateUin": 20548499,
"Qps": 5000,
"Bps": 52428800,
"MaxDelaySeconds": 3600,
"MaxMsgHeapNum": 23232323,
"PollingWaitSeconds": 3,
"MsgRetentionSeconds": 232323,
"VisibilityTimeout": 12,
"MaxMsgSize": 121223,
"RewindSeconds": 0,
"CreateTime": 1581412802,
"LastModifyTime": 1581471003,
"Transaction": null,
"DeadLetterSource": [
{
"QueueId": "queue-kc7m75to",
"QueueName": "test"
}
],
"DeadLetterPolicy": null,
"TransactionPolicy": null,
"ActiveMsgNum": 0,
"InactiveMsgNum": 0,
"DelayMsgNum": 0,
"RewindMsgNum": 0,
"MinMsgTime": 1582015467
},
{
"Tags": [],
"QueueId": "queue-dvukxexc",
"QueueName": "dead",
"CreateUin": 20548499,
"Qps": 5000,
"Bps": 52428800,
"MaxDelaySeconds": 3600,
"MaxMsgHeapNum": 100000000,
"PollingWaitSeconds": 0,
"MsgRetentionSeconds": 345600,
"VisibilityTimeout": 30,
"MaxMsgSize": 65536,
"RewindSeconds": 0,
"CreateTime": 1581418590,
"LastModifyTime": 1581418590,
"Transaction": null,
"DeadLetterSource": [],
"DeadLetterPolicy": null,
"TransactionPolicy": null,
"ActiveMsgNum": 0,
"InactiveMsgNum": 0,
"DelayMsgNum": 0,
"RewindMsgNum": 0,
"MinMsgTime": 1582015467
},
{
"Tags": [],
"QueueId": "queue-cdb91yt6",
"QueueName": "test21",
"CreateUin": 20548499,
"Qps": 5000,
"Bps": 52428800,
"MaxDelaySeconds": 3600,
"MaxMsgHeapNum": 100000000,
"PollingWaitSeconds": 0,
"MsgRetentionSeconds": 345600,
"VisibilityTimeout": 30,
"MaxMsgSize": 65536,
"RewindSeconds": 0,
"CreateTime": 1581413384,
"LastModifyTime": 1581413384,
"Transaction": null,
"DeadLetterSource": [],
"DeadLetterPolicy": null,
"TransactionPolicy": null,
"ActiveMsgNum": 0,
"InactiveMsgNum": 0,
"DelayMsgNum": 0,
"RewindMsgNum": 0,
"MinMsgTime": 1582015467
}
],
"RequestId": "3f9a8b31-ac0d-4abd-8af2-e8564ceac30a"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.TryLater | 操作进行中，请稍后重试。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
