1. API Description

API: GetMonitorData
Domain name for API request: monitor.tencentcloudapi.com

This API is used to get the monitoring data of a Tencent Cloud product by passing in the product's namespace, object dimension description, and monitoring metrics.

API call rate limit: 20 calls/second (1,200 calls/minute). A single request can get the monitoring data of up to 10 instances and up to 1,440 data points.

This API may fail due to the rate limit if you need to call many metrics and objects. We recommend that you distribute call requests across a period of time.

To query the monitoring data of a Direct Connect dedicated tunnel, use the following input parameters:
&Namespace= QCE/DCX
&Instances.N.Dimensions.0.Name=directConnectConnId
&Instances.N.Dimensions.0.Value=Dedicated tunnel ID

2. Input Parameters

The list below contains only the API request parameters and certain common request parameters. Common request parameters need to be added when a call is made. For more information, see Common Params.

2.1. Input parameters

2.1.1. Overview of input parameters

2.1.2. Dimension parameters

2.2. Metric names

The statistical granularity (period) and dimension (dimension) may vary by metric. The DescribeBaseMetrics API can be used to get the period and dimension supported by each metric.

3. Output Parameters

4. Error Codes

5. Samples

Sample 1

This example shows you how to get the monitoring data for the inbound bandwidth of one Direct Connect dedicated tunnel using a statistical period of 300 seconds for a specified length of time.

Sample input code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace= QCE/DCX
&MetricName=Inbandwidth
&Period=300
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2019-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=directConnectConnId
&Instances.0.Dimensions.0.Value=dcx-123456abc
&<Common request parameters>

Sample output code

{
  "Response": {
    "StartTime": "2019-05-08 16:40:00",
    "EndTime": "2019-05-08 16:45:00",
    "Period": 300,
    "MetricName": "Inbandwidth",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "directConnectConnId",
            "Value": "dc-123456abc"
          }
        ],
        "Timestamps": [
          1558459800,
          1558460100
        ],
        "Values": [
          15.6,
          17.9
        ]
      }
    ],
    "RequestId": "23a38f36-5c73-43fb-ae46-12345678"
  }
}

Sample 2

This example shows you how to get the monitoring data for the inbound bandwidth of multiple Direct Connect dedicated tunnels using a statistical period of 300 seconds for a specified length of time.

Sample input code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace= QCE/DCX
&MetricName=Inbandwidth
&Period=300
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2019-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=directConnectConnId
&Instances.0.Dimensions.0.Value=dcx-123456abc
&Instances.1.Dimensions.0.Name=directConnectConnId
&Instances.1.Dimensions.0.Value=dcx-123456def
&<Common request parameters>

Sample output code

{
  "Response": {
    "StartTime": "2019-05-08 16:40:00",
    "EndTime": "2019-05-08 16:45:00",
    "Period": 300,
    "MetricName": "Inbandwidth",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "directConnectConnId",
            "Value": "dc-123456abc"
          }
        ],
        "Timestamps": [
          1558459800,
          1558460100
        ],
        "Values": [
          15.6,
          17.9
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "directConnectConnId",
            "Value": "dcx-123456def"
          }
        ],
        "Timestamps": [
          1558459800,
          1558460100
        ],
        "Values": [
          15.6,
          17.9
        ]
      }
    ],
    "RequestId": "23a38f36-5c73-43fb-ae46-12345678"
  }
}