DescribeCmqSubscriptionDetail

Last updated: 2025-11-25 10:54:49

DescribeCmqSubscriptionDetail

Last updated: 2025-11-25 10:54:49

1. API Description

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

This API is used to query the CMQ subscription details.

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: DescribeCmqSubscriptionDetail.
Version	Yes	String	Common Params. The value used for this API: 2020-02-17.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
TopicName	No	String	Topic name, which must be unique under the same account in a single region. The name is a string of no more than 64 characters, starting with a letter, and the remaining part may include letters, numbers, and hyphens (-).
Offset	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
Limit	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.
SubscriptionName	No	String	Fuzzy search by `SubscriptionName`
QueueName	No	String	Queue name. Endpoint of bound subscription
QueryType	No	String	Query type. valid values: (1) topic; (2) queue. Default value is topic. if queryType is topic, query subscriptions under the topic. if queryType is queue, query subscriptions bound to the queue.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number
SubscriptionSet	Array of CmqSubscription	Subscription attribute collection
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 Querying subscription details

Input Example

https://tdmq.intl.tencentcloudapi.com/?Action=DescribeCmqSubscriptionDetail
&TopicName=Conn
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "SubscriptionSet": [
            {
                "SubscriptionName": "ConnSub",
                "SubscriptionId": "subsc-8y7fn4t2",
                "TopicOwner": 0,
                "MsgCount": 0,
                "LastModifyTime": 1590632987,
                "CreateTime": 1590632987,
                "BindingKey": null,
                "Endpoint": "test1",
                "FilterTags": [],
                "Protocol": "queue",
                "NotifyStrategy": "EXPONENTIAL_DECAY_RETRY",
                "NotifyContentFormat": "SIMPLIFIED"
            }
        ],
        "RequestId": "72cd2d9d-d666-45ad-963a-cf5065a1984c"
    }
}

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

Tencent Cloud CLI 3.0

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.CmqBackendError	CMQ backend error.
ResourceNotFound.Topic	The topic does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud