DescribeDeadLetterSourceQueues

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 the source queues of a dead letter queue.

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: DescribeDeadLetterSourceQueues.
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.
DeadLetterQueueName Yes String Dead letter queue name
Limit No Integer Starting position of topic 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.
Offset No Integer Number of topics 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 Filters source queue name of dead letter queue. Currently, only filtering by SourceQueueName is supported

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible queues
QueueSet Array of DeadLetterSource Source queues of dead letter queue
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Enumerating the source queues of dead letter queue

This example shows you how to enumerate the source queues of a dead letter queue.

Input Example

https://cmq.tencentcloudapi.com/?Action=DescribeDeadLetterSourceQueues
&DeadLetterQueueName=test123
&<Common request parameters>

Output Example

{
  "Response": {
    "QueueSet": [
      {
        "QueueName": "test",
        "QueueId": "queue-kc7m75to"
      }
    ],
    "TotalCount": 1,
    "RequestId": "83fce81a-7305-49b4-a154-983dd76204da"
  }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

Was this page helpful?

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