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, and monitoring metric.

API call rate limit: 20 calls/second (1,200 calls/minute). A single request can get the 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 over a period of time.

To query the monitoring data of a VPN gateway in a VPC, use the following input parameters:
&Namespace=QCE/VPNGW
&Instances.N.Dimensions.0.Name=vpnGwId
&Instances.N.Dimensions.0.Value=VPN gateway ID

2. Input Parameters

The list below contains only the API request parameters and some common 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. Overview of parameters in each dimension

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 public network outbound bandwidth of one VPN gateway in a VPC using a statistical period of 60 seconds for a specified length of time.

Input sample code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/VPNGW
&MetricName=Outbandwidth
&Period=60
&StartTime=2019-06-11T00:00:00+08:00
&EndTime=2019-06-11T00:05:00+08:00
&Instances.0.Dimensions.0.Name=vpnGwId
&Instances.0.Dimensions.0.Value=vpngw-q7v069tf
&<Common request parameters>

Output sample code

{
  "Response": {
    "StartTime": "2019-06-11 00:00:00",
    "EndTime": "2019-06-11 00:05:00",
    "Period": 60,
    "MetricName": "Outbandwidth",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vpnGwId",
            "Value": "vpngw-1234567"
          }
        ],
        "Timestamps": [
          1560182400,
          1560182460,
          1560182520,
          1560182580,
          1560182640,
          1560182700
        ],
        "Values": [
          0.004,
          0.003,
          0.003,
          0.003,
          0.003,
          0.003
        ]
      }
    ],
    "RequestId": "922600e6-3fca-4b91-9ff1-dbb02a0ca017"
  }
}

Sample 2

This example shows you how to get the monitoring data for the public network outbound bandwidth of multiple VPN gateways in a VPC using a statistical period of 60 seconds for a specified length of time.

Input sample code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/BLOCK_STORAGE
&MetricName=Outbandwidth
&Period=60
&StartTime=2019-06-11T00:00:00+08:00
&EndTime=2019-06-11T00:05:00+08:00
&Instances.0.Dimensions.0.Name=vpnGwId
&Instances.0.Dimensions.0.Value=vpngw-1234567
&Instances.1.Dimensions.0.Name=vpnGwId
&Instances.1.Dimensions.0.Value=vpngw-12345678
&<Common request parameters>

Output sample code

{
  "Response": {
    "StartTime": "2019-06-11 00:00:00",
    "EndTime": "2019-06-11 00:05:00",
    "Period": 60,
    "MetricName": "Outbandwidth",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vpnGwId",
            "Value": "vpngw-1234567"
          }
        ],
        "Timestamps": [
          1560182400,
          1560182460,
          1560182520,
          1560182580,
          1560182640,
          1560182700
        ],
        "Values": [
          0.004,
          0.003,
          0.003,
          0.003,
          0.003,
          0.003
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "vpnGwId",
            "Value": "vpngw-12345678"
          }
        ],
        "Timestamps": [
          1560182400,
          1560182460,
          1560182520,
          1560182580,
          1560182640,
          1560182700
        ],
        "Values": [
          0.004,
          0.003,
          0.003,
          0.003,
          0.003,
          0.003
        ]
      }
    ],
    "RequestId": "922600e6-3fca-4b91-9ff1-dbb02a0ca017"
  }
}