GetMonitorData

Last updated: 2021-01-11 14:28:12

1. API Description

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

This API is used to 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 obtain 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 a lot of metrics and objects. We recommended that you spread the call requests over time.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: monitor.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: GetMonitorData.
Version Yes String Common parameter. The value used for this API: 2018-07-24.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Namespace Yes String Namespace, such as QCE/CVM. For more information on the namespaces of each Tencent Cloud service, please see Tencent Cloud Service Metrics
MetricName Yes String Metric name, such as CPUUsage. For more information on the metrics of each Tencent Cloud service, please see Tencent Cloud Service Metrics. The corresponding metric name is the MetricName
Instances.N Yes Array of Instance Dimension combination of instance object in the format of key-value pair, such as [{"Name":"InstanceId","Value":"ins-j0hk02zo"}]. For more information on the dimensions of each Tencent Cloud service, please see Tencent Cloud Service Metrics. The value in the dimension column is the key in the dimension combination, and the value corresponding to the key is the value in the combination
Period No Integer Monitoring statistical period in seconds, such as 60. Default value: 300. The statistical period varies by metric. For more information on the statistical periods supported by each Tencent Cloud service, please see Tencent Cloud Service Metrics. The values in the statistical period column are the supported statistical periods
StartTime No Timestamp ISO8601 Start time such as 2018-09-22T19:51:23+08:00
EndTime No Timestamp ISO8601 End time, which is the current time by default, such as 2018-09-22T20:51:23+08:00. EndTime cannot be earlier than StartTime

3. Output Parameters

Parameter Name Type Description
Period Integer Statistical period
MetricName String Metric name
DataPoints Array of DataPoint Array of data points
StartTime Timestamp ISO8601 Start time
EndTime Timestamp ISO8601 End time
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the monitoring data of one CVM instance

This example shows you how to get the 5-minute CPU utilization monitoring data of one CVM instance in a certain period 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 5-minute CPU utilization monitoring data of multiple CVM instances in a certain period 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-22 19:50:00",
    "EndTime": "2018-09-22 20:50: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 one TencentDB instance

This example shows you how to get the 5-minute CPU utilization monitoring data of one TencentDB instance in a certain period 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-22 19:20:00",
    "EndTime": "2018-09-22 20:20: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.

Command Line Interface

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.
InvalidParameterValue The parameter value is incorrect.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help