tencent cloud

DescribeTopicMsgs
Last updated: 2025-11-25 10:54:06
DescribeTopicMsgs
Last updated: 2025-11-25 10:54:06

1. API Description

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

This API is used to query messages.

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: DescribeTopicMsgs.
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.
StartTime Yes String Start time.
EndTime Yes String End time.
Offset No Integer Starting index. Default is 0 if left empty.
Limit No Integer Number of returns, default to 10 if not specified, maximum value: 20.
MsgId No String Message ID.
ClusterId No String Pulsar cluster ID

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total record count.
TopicMsgLogSets Array of MsgLog Message log list.
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 Message Query

Input Example

https://tdmq.intl.tencentcloudapi.com/?Action=DescribeTopicMsgs
&EnvironmentId=default
&TopicName=test-topic3
&StartTime=2020-09-22 00:00:00
&EndTime=2020-09-22 00:00:00
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 10000,
        "TopicMsgLogSets": [
            {
                "MsgId": "15591:9:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:14,281",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:8:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:14,074",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:7:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:13,867",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:6:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:13,658",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:5:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:13,449",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:4:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:13,242",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:3:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:13,015",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:2:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:12,808",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:1:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:12,600",
                "ProducerAddr": "9.139.220.17:37960"
            },
            {
                "MsgId": "15591:0:-1",
                "ProducerName": "fisrtProducer",
                "ProduceTime": "2020-08-14 16:47:12,390",
                "ProducerAddr": "9.139.220.17:37960"
            }
        ],
        "RequestId": "msgs"
    }
}

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
FailedOperation.CloudService Third-Party cloud service exception. try again later.
FailedOperation.OperateLater Task in progress. please try again later.
InvalidParameterValue.InvalidParams The parameter value is out of the value range.
LimitExceeded.MsgTime Message trace query time period is too long.
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
No

Feedback