tencent cloud

DescribeRocketMQPublicAccessMonitorData
Last updated: 2025-11-25 10:52:55
DescribeRocketMQPublicAccessMonitorData
Last updated: 2025-11-25 10:52:55

1. API Description

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

This API is used to pull public network metric monitoring data from TCOP. Currently, only inbound bandwidth and outbound bandwidth metrics from client to LB are supported.

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: DescribeRocketMQPublicAccessMonitorData.
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.
InstanceId Yes String Exclusive Edition cluster ID.
MetricName Yes String Metric name. Only single-metric pulling is supported. Currently supported metrics: ClientIntraffic and ClientOuttraffic.
StartTime No String Start time.
EndTime No String End time, current time by default.
Period No Integer Monitoring statistical period, such as 60 (in seconds). The default value is 300.

3. Output Parameters

Parameter Name Type Description
MetricName String Metric name.
Note: This field may return null, indicating that no valid values can be obtained.
Period Integer Monitoring statistical period, such as 60 (in seconds). The default value is 300.
Note: This field may return null, indicating that no valid values can be obtained.
StartTime String Start time, for example, 2018-09-22T19:51:23+08:00.
Note: This field may return null, indicating that no valid values can be obtained.
EndTime String End time, such as 2018-09-22T20:51:23+08:00. The default value is the current time.
Note: This field may return null, indicating that no valid values can be obtained.
DataPoints Array of RocketMQDataPoint Data point array
Note: This field may return null, indicating that no valid values can be obtained.
Msg String Returned information.
Note: This field may return null, indicating that no valid values can be obtained.
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 Normal Response

Input Example

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

{
    "InstanceId": "rocketmq-a52qova7x97b",
    "StartTime": "2024-12-04T15:06:49+08:00",
    "EndTime": "2024-12-04T16:06:49+08:00",
    "Period": 60,
    "MetricName": "RocketmqPublicNetworkIntrafficVipRatio"
}

Output Example

{
    "Response": {
        "StartTime": "2024-12-04T15:06:00+08:00",
        "EndTime": "2024-12-04T16:06:00+08:00",
        "Period": 60,
        "MetricName": "RocketmqPublicNetworkIntrafficVipRatio",
        "DataPoints": [
            {
                "Timestamps": [
                    1733295960,
                    1733296020,
                    1733296080,
                    1733296140,
                    1733296200,
                    1733296260,
                    1733296320,
                    1733296380,
                    1733296440,
                    1733296500,
                    1733296560,
                    1733296620,
                    1733296680,
                    1733296740,
                    1733296800,
                    1733296860,
                    1733296920,
                    1733296980,
                    1733297040,
                    1733297100,
                    1733297160,
                    1733297220,
                    1733297280,
                    1733297340,
                    1733297400,
                    1733297460,
                    1733297520,
                    1733297580,
                    1733297640,
                    1733297700,
                    1733297760,
                    1733297820,
                    1733297880,
                    1733297940,
                    1733298000,
                    1733298060,
                    1733298120,
                    1733298180,
                    1733298240,
                    1733298300,
                    1733298360,
                    1733298420,
                    1733298480,
                    1733298540,
                    1733298600,
                    1733298660,
                    1733298720,
                    1733298780,
                    1733298840,
                    1733298900,
                    1733298960,
                    1733299020,
                    1733299080,
                    1733299140,
                    1733299200,
                    1733299260
                ],
                "Values": [
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            }
        ],
        "RequestId": "a6ebee33-5790-435a-a204-dda200d360af",
        "Msg": ""
    }
}

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.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback