tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCmqDeadLetterSourceQueues

Last updated: 2023-08-09 14:43:35

1. API Description

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

This API is used to enumerate the source queues of a CMQ dead letter queue.

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: DescribeCmqDeadLetterSourceQueues.
Version Yes String Common Params. The value used for this API: 2020-02-17.
Region No String Common Params. This parameter is not required for this API.
DeadLetterQueueName Yes String Dead letter queue name
Limit No Integer Starting position of the list of topics 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.
SourceQueueName No String Filter by SourceQueueName

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible queues
QueueSet Array of CmqDeadLetterSource 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

Input Example

https://tdmq.tencentcloudapi.com/?Action=DescribeCmqDeadLetterSourceQueues
&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

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.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy