- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- 消息队列（Queue）模型
- 消息主题（Topic）模型
- 迁移说明
- 案例分享
- API 文档
- SDK 文档
- 服务等级协议
- 词汇表
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- 消息队列（Queue）模型
- 消息主题（Topic）模型
- 迁移说明
- 案例分享
- API 文档
- SDK 文档
- 服务等级协议
- 词汇表
1. API Description
Domain name for API request: cmq.intl.tencentcloudapi.com.
This API is used to enumerate queues.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeQueueDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2019-03-04. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Offset | No | Integer | Starting position of queue list to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default |
| Limit | No | Integer | Number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. |
| Filters.N | No | Array of Filter | Filter parameter. Currently, filtering by QueueName is supported, and only one keyword is allowed |
| TagKey | No | String | Tag search |
| QueueName | No | String | Exact match by QueueName |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of queues |
| QueueSet | Array of QueueSet | Queue list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Getting queue list
Input Example
https://cmq.intl.tencentcloudapi.com/?Action=DescribeQueueDetail
&<Common request parameters>
Output Example
{
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.TryLater | The operation is in progress. Please try again later. |
| InvalidParameter | Invalid parameter. |
| LimitExceeded | The quota limit is exceeded. |
| ResourceInUse | The resource is in use. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation | Unauthorized operation. |
是
否
本页内容是否解决了您的问题？