tencent cloud

Feedback

DescribeSubscriptions

Last updated: 2022-07-18 14:12:30

1. API Description

Domain name for API request: tdmq.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.
EnvironmentId Yes String Environment (namespace) name.
TopicName Yes String Topic name.
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.
ClusterId No String Pulsar cluster ID

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the consumer subscription list

Input Example

https://tdmq.tencentcloudapi.com/?Action=DescribeSubscriptions
&EnvironmentId=test1
&TopicName=test
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "SubscriptionSets": [
      {
        "EnvironmentId": "test1",
        "TopicName": "test",
        "ConnectedSince": "",
        "ConsumerAddr": "",
        "ConsumerCount": "6",
        "ConsumerName": "",
        "MsgBacklog": "1087",
        "MsgRateExpired": "0.0",
        "MsgRateOut": "0.0",
        "SubType": "xx",
        "MsgThroughputOut": "0.0",
        "SubscriptionName": "test",
        "BlockedSubscriptionOnUnackedMsgs": true,
        "MaxUnackedMsgNum": 0,
        "Remark": "",
        "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",
            "ClientVersion": ""
          },
          {
            "ConnectedSince": "2021-01-13T15:22:20.197+08:00",
            "ConsumerAddr": "/9.219.234.202:6374",
            "ConsumerName": "dkhtb",
            "ClientVersion": ""
          },
          {
            "ConnectedSince": "2021-01-13T15:22:50.282+08:00",
            "ConsumerAddr": "/9.219.237.139:57322",
            "ConsumerName": "ejbij",
            "ClientVersion": ""
          },
          {
            "ConnectedSince": "2021-01-13T15:18:50.927+08:00",
            "ConsumerAddr": "/9.219.233.137:62564",
            "ConsumerName": "hijsf",
            "ClientVersion": ""
          },
          {
            "ConnectedSince": "2021-01-13T15:21:50.227+08:00",
            "ConsumerAddr": "/9.219.234.202:11554",
            "ConsumerName": "nbcra",
            "ClientVersion": ""
          },
          {
            "ConnectedSince": "2021-01-13T15:19:51.032+08:00",
            "ConsumerAddr": "/9.219.232.202:19345",
            "ConsumerName": "vjmts",
            "ClientVersion": ""
          }
        ],
        "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

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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support