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.

Cloud Load Balancer (CLB) is a traffic distribution service for multiple CVMs. For more information, see Cloud Load Balancer. Currently, CLB supports four types of namespace: QCE/LB_PUBLIC, QCE/LB_PRIVATE, QCE/LB_RS_PRIVATE, and QCE/LOADBALANCE.

QCE/LB_PUBLIC: indicates the namespace for public network CLB, which includes monitoring data in the CLB and real server dimensions.
QCE/LB_PRIVATE: indicates the namespace for private network CLB, which includes monitoring data in the CLB dimension.
QCE/LB_RS_PRIVATE: indicates the namespace for private network CLB, which includes monitoring data in the real server dimension.
QCE/LOADBALANCE: indicates the namespace for CLB layer-7 data.

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.

QCE/LB_PRIVATE is the namespace for private network CLB in the CLB dimension, and can be used to query the monitoring data in the private network CLB dimension. QCE/LB_PRIVATE is used to query monitoring data based on the following 2 dimension groups. The values of input parameters are as follows:

1.1. Values of input parameters in the private network CLB dimension

&Namespace=QCE/LB_PRIVATE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value=IP address
&Instances.N.Dimensions.1.Name=vpcId
&Instances.N.Dimensions.1.Value=VPC ID of the CLB instance

1.2. Values of input parameters in the private network CLB instance port dimension

&Namespace=QCE/LB_PRIVATE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value=IP address
&Instances.N.Dimensions.1.Name=vpcId
&Instances.N.Dimensions.1.Value=VPC ID of the CLB instance
&Instances.N.Dimensions.2.Name=loadBalancerPort
&Instances.N.Dimensions.2.Value=Port number
&Instances.N.Dimensions.3.Name=protocol
&Instances.N.Dimensions.3.Value=Protocol type

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. 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 number of new connections added for one private network CLB instance using a statistical period of 60 seconds for a specified length of time.

Sample input code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/LB_PRIVATE
&MetricName=NewConn
&Period=60
&StartTime=2019-05-20T16:01:00+08:00
&EndTime=2019-05-20T16:05:00+08:00
&Instances.0.Dimensions.0.Name=vip
&Instances.0.Dimensions.0.Value=111.111.111.11
&Instances.0.Dimensions.1.Name=vpcId
&Instances.0.Dimensions.1.Value=1012345
&<Common request parameters>

Sample output code

{
  "Response": {
    "StartTime": "2019-05-20 16:01:00",
    "EndTime": "2019-05-20 16:05:00",
    "Period": 60,
    "MetricName": "NewConn",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "111.111.111.11"
          },
          {
            "Name": "vpcId",
            "Value": "1012345"
          }
        ],
        "Timestamps": [
          1558339260,
          1558339320,
          1558339380,
          1558339440,
          1558339500
        ],
        "Values": [
          12,
          34,
          23,
          45,
          31
        ]
      }
    ],
    "RequestId": "9a6ede5f-884a-43cb-9aa6-7082f0657509"
  }
}

Sample 2

This example shows you how to get the monitoring data for the number of new connections added for multiple private network CLB instances using a statistical period of 60 seconds for a specified length of time.

Sample input code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/LB_PRIVATE
&MetricName=NewConn
&Period=60
&StartTime=2019-05-20T16:01:00+08:00
&EndTime=2019-05-20T16:05:00+08:00
&Instances.0.Dimensions.0.Name=vip
&Instances.0.Dimensions.0.Value=111.111.111.11
&Instances.0.Dimensions.1.Name=vpcId
&Instances.0.Dimensions.1.Value=1012345
&Instances.1.Dimensions.0.Name=vip
&Instances.1.Dimensions.0.Value=222.222.222.22
&Instances.1.Dimensions.1.Name=vpcId
&Instances.1.Dimensions.1.Value=10123456
&<Common request parameters>

Sample output code

{
  "Response": {
    "StartTime": "2019-05-20 16:01:00",
    "EndTime": "2019-05-20 16:05:00",
    "Period": 60,
    "MetricName": "NewConn",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "111.111.111.11"
          },
          {
            "Name": "vpcId",
            "Value": "1012345"
          }
        ],
        "Timestamps": [
          1558339260,
          1558339320,
          1558339380,
          1558339440,
          1558339500
        ],
        "Values": [
          12,
          34,
          23,
          45,
          31
        ]
      }，
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "222.222.222.22"
          },
          {
            "Name": "vpcId",
            "Value": "10123456"
          }
        ],
        "Timestamps": [
          1558339260,
          1558339320,
          1558339380,
          1558339440,
          1558339500
        ],
        "Values": [
          12,
          34,
          23,
          45,
          31
        ]
      }
    ],
    "RequestId": "9a6ede5f-884a-43cb-9aa6-7082f0657509"
  }
}