GetNetMonitor

Download

Mode fokus

Ukuran font

Terakhir diperbarui: 2026-05-21 10:26:15

1. API Description

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

This API is used to obtain real-time traffic statistics per device.

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: GetNetMonitor.
Version	Yes	String	Common Params. The value used for this API: 2021-01-19.
Region	No	String	Common Params. This parameter is not required for this API.
DeviceId	Yes	String	device id
BeginTime	Yes	Integer	Start time.
EndTime	Yes	Integer	End time.
Metrics	Yes	String	Statistical metric (Uplink rate: "TxRate": bit/s, Downstream rate: "RxRate": bit/s, Packet Loss: "Loss": %, Latency: "RTT": ms)
GatewayType	No	Integer	Gateway type. 0: public cloud gateway; 1: private gateway. Defaults to 0 if not specified.

3. Output Parameters

Parameter Name	Type	Description
MonitorData	Array of MonitorData	Monitoring data.
AccessRegion	String	Access region. Value ranges from 'MC' to 'AM' MC=Chinese mainland AP=Asia Pacific EU=Europe AM=Americas
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 Query Device Downstream Rate for Specified Time Period

Input Example

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

{
    "DeviceId": "mna-yujpsea3v0",
    "BeginTime": 1776346200,
    "EndTime": 1776346500,
    "Metrics": "RxRate"
}

Output Example

{
    "Response": {
        "AccessRegion": "MC",
        "MonitorData": [
            {
                "BusinessMetrics": 262585.6,
                "SlotNetInfo": [
                    {
                        "Current": 285197.866667,
                        "NetInfoName": "eth1",
                        "PublicIP": "115.227.8.235:19991"
                    }
                ],
                "Time": "1776346200"
            }
        ],
        "RequestId": "ceb36604-8a38-4147-8cd8-89d905facf52"
    }
}

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
InternalError	Internal error.
InternalError.ControlRequestError	Request controller encounters an error.
InternalError.NetworkInfoRequestError	Zhiyan traffic data request error.
InvalidParameterValue	Parameter value error.
InvalidParameterValue.TimeFuture	Query end time is later than current system time
InvalidParameterValue.TimeSpanExceeded	Query time span exceeds 7 days
InvalidParameterValue.TimeTooEarly	Start time earlier than 30 days ago

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

Multiple Network Acceleration