DescribeQueueDetail

Last updated: 2020-05-09 10:25:46

1. API Description

Domain name for API request: cmq.tencentcloudapi.com.

This API is used to enumerate queues.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cmq.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeQueueDetail.
Version Yes String Common parameter. The value used for this API: 2019-03-04.
Region Yes String Common parameter. 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting queue list

Input Example

https://cmq.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

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help