tencent cloud

1. API Description

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

This API is used to get the monitoring data of Tencent Cloud services except TKE. To pull TKE’s monitoring data, please use the API DescribeStatisticData.
You can get the monitoring data of a Tencent Cloud service by passing in its namespace, object dimension description, and monitoring metrics.
API call rate limit: 20 calls/second (1,200 calls/minute). A single request can get the data of up to 10 instances for up to 1,440 data points.
If you need to call a large number of APIs to pull metrics or objects at a time, some APIs may fail to be called due to the rate limit. We suggest you evenly arrange API calls at a time granularity.

A maximum of 20 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Getting the monitoring data of a CVM Instance

This example shows you how to get the CPU utilization monitoring data of a CVM instance using a statistical period of 5 minutes for a specified length of time.

Input Example

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

{
    "Namespace": "QCE/CVM",
    "MetricName": "CPUUsage",
    "Period": 300,
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "ins-j0hk02zo"
                }
            ]
        }
    ],
    "StartTime": "2019-03-24T10:51:23+08:00",
    "EndTime": "2019-03-24T20:51:23+08:00"
}

Output Example

{
  "Response": {
    "StartTime": "2019-03-24T10:50:00+08:00",
    "EndTime": "2019-03-24T20:50:00+08:00",
    "Period": 300,
    "MetricName": "CPUUsage",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "InstanceId",
            "Value": "ins-j0hk02zo"
          }
        ],
        "Timestamps": [
          1535079000,
          1535079300,
          1535079600,
          1535079900,
          1535080200,
          1535080500
        ],
        "Values": [
          2.566,
          2.283,
          6.316,
          2.816,
          2.7,
          2.35
        ]
      }
    ],
    "RequestId": "d96ec542-6547-4af2-91ac-fee85c1b8b85"
  }
}

Example2 Getting the monitoring data of multiple CVM instances

This example shows you how to get the CPU utilization monitoring data of multiple CVM instances using a statistical period of 5 minutes for a specified length of time.

Input Example

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

{
    "Namespace": "QCE/CVM",
    "MetricName": "CPUUsage",
    "Period": 300,
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "ins-j0hk02zo"
                }
            ]
        },
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "ins-o8vv2w10"
                }
            ]
        }
    ],
    "StartTime": "2018-09-22T19:51:23+08:00",
    "EndTime": "2018-09-22T20:51:23+08:00"
}

Output Example

{
  "Response": {
    "StartTime": "2018-09-22T19:50:00+08:00",
    "EndTime": "2018-09-22T20:50:00+08:00",
    "Period": 300,
    "MetricName": "CPUUsage",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "InstanceId",
            "Value": "ins-j0hk02zo"
          }
        ],
        "Timestamps": [],
        "Values": []
      },
      {
        "Dimensions": [
          {
            "Name": "InstanceId",
            "Value": "ins-o8vv2w10"
          }
        ],
        "Timestamps": [],
        "Values": []
      }
    ],
    "RequestId": "9ac53ccc-fbab-483d-980b-b763bcc2f83f"
  }
}

Example3 Getting the monitoring data of a TencentDB instance

This example shows you how to get the CPU utilization monitoring data of a TencentDB instance using a statistical period of 5 minutes for a specified length of time.

Input Example

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

{
    "Namespace": "QCE/CDB",
    "MetricName": "SlowQueries",
    "Period": 300,
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "cdb-k5d6z7p0"
                },
                {
                    "Name": "InstanceType",
                    "Value": "2"
                }
            ]
        }
    ],
    "StartTime": "2018-09-22T19:23:07+08:00",
    "EndTime": "2018-09-22T20:23:07+08:00"
}

Output Example

{
  "Response": {
    "StartTime": "2018-09-22T19:20:00+08:00",
    "EndTime": "2018-09-22T20:20:00+08:00",
    "Period": 300,
    "MetricName": "SlowQueries",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "InstanceType",
            "Value": "2"
          },
          {
            "Name": "InstanceId",
            "Value": "cdb-k5d6z7p0"
          }
        ],
        "Timestamps": [],
        "Values": []
      }
    ],
    "RequestId": "2bcfe8b7-8ea8-4488-9d17-f1aeb106eecd"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.