DescribeSubscriptions

Last updated: 2025-11-25 10:53:42

DescribeSubscriptions

Last updated: 2025-11-25 10:53:42

1. API Description

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

This API is used to query the list of subscribers under the specified environment and topic.

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: DescribeSubscriptions.
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-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
EnvironmentId	Yes	String	Environment (namespace) name.
TopicName	Yes	String	Topic name.
ClusterId	Yes	String	Pulsar cluster ID
Offset	No	Integer	Offset, which defaults to 0 if left empty.
Limit	No	Integer	The number of results to be returned, which defaults to 10 if left empty. The maximum value is 20.
SubscriptionName	No	String	Fuzzy match by subscriber name.
Filters.N	No	Array of FilterSubscription	Data filter.

3. Output Parameters

Parameter Name	Type	Description
SubscriptionSets	Array of Subscription	Array of subscriber sets.
TotalCount	Integer	The total number of returned results.
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 Spending Subscription List

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubscriptions
<Common request parameters>

{
    "EnvironmentId": "devNamespace",
    "TopicName": "devTopic",
    "Offset": 0,
    "Limit": 1,
    "SubscriptionName": "devSub",
    "Filters": [
        {
            "ConsumerHasCount": true,
            "ConsumerHasBacklog": true,
            "ConsumerHasExpired": true,
            "SubscriptionNames": [
                "devSub"
            ]
        }
    ],
    "ClusterId": "pulsar-b843bz38z5mz"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "SubscriptionSets": [
            {
                "EnvironmentId": "devNamespace",
                "TopicName": "devTopic",
                "ConnectedSince": "2024-10-08 11:38:48",
                "ConsumerAddr": "127.0.0.1",
                "ConsumerCount": "6",
                "ConsumerName": "devName",
                "MsgBacklog": "1087",
                "MsgRateExpired": "0.0",
                "MsgRateOut": "0.0",
                "SubType": null,
                "MsgThroughputOut": "0.0",
                "SubscriptionName": "devSub",
                "BlockedSubscriptionOnUnackedMsgs": true,
                "MaxUnackedMsgNum": 0,
                "Remark": "devRemark",
                "CreateTime": "2020-09-18 14:32:41",
                "UpdateTime": "2021-01-13 15:23:35",
                "IsOnline": true,
                "ConsumerSets": [
                    {
                        "ConnectedSince": "2021-01-13T15:19:21.03+08:00",
                        "ConsumerAddr": "/9.219.234.200:9056",
                        "ConsumerName": "axjoy",
                        "Partition": 4,
                        "ClientVersion": "2.7.2"
                    },
                    {
                        "ConnectedSince": "2021-01-13T15:22:20.197+08:00",
                        "ConsumerAddr": "/9.219.234.202:6374",
                        "ConsumerName": "dkhtb",
                        "Partition": 4,
                        "ClientVersion": "2.7.2"
                    },
                    {
                        "ConnectedSince": "2021-01-13T15:22:50.282+08:00",
                        "ConsumerAddr": "/9.219.237.139:57322",
                        "ConsumerName": "ejbij",
                        "Partition": 4,
                        "ClientVersion": "2.7.2"
                    },
                    {
                        "ConnectedSince": "2021-01-13T15:18:50.927+08:00",
                        "ConsumerAddr": "/9.219.233.137:62564",
                        "ConsumerName": "hijsf",
                        "Partition": 4,
                        "ClientVersion": "2.7.2"
                    },
                    {
                        "ConnectedSince": "2021-01-13T15:21:50.227+08:00",
                        "ConsumerAddr": "/9.219.234.202:11554",
                        "ConsumerName": "nbcra",
                        "Partition": 4,
                        "ClientVersion": "2.7.2"
                    },
                    {
                        "ConnectedSince": "2021-01-13T15:19:51.032+08:00",
                        "ConsumerAddr": "/9.219.232.202:19345",
                        "ConsumerName": "vjmts",
                        "Partition": 4,
                        "ClientVersion": "2.7.2"
                    }
                ],
                "ConsumersScheduleSets": [
                    {
                        "NumberOfEntries": 4642,
                        "Partitions": 0,
                        "MsgBacklog": 1087,
                        "MsgRateOut": "0.0",
                        "MsgThroughputOut": "0.0",
                        "MsgRateExpired": "0.0"
                    }
                ]
            }
        ],
        "RequestId": "39ab02af-30c8-41d4-9ac4-46cb519ceac0"
    }
}

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
AuthFailure.UnauthorizedOperation	CAM authentication failed.
FailedOperation	Operation failed.
FailedOperation.DescribeSubscription	Failed to query the subscription data.
InternalError.SystemError	System error.
InvalidParameterValue.InvalidParams	The parameter value is out of the value range.
MissingParameter.NeedMoreParams	A required parameter is missing.
ResourceNotFound.BrokerCluster	The service cluster does not exist.
ResourceNotFound.Cluster	The cluster does not exist.
ResourceNotFound.Environment	The environment does not exist.
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