Help & DocumentationAPIsBasic Cloud MonitorProduct APIsTKE - Monitoring API in Service Dimension

TKE - Monitoring API in Service Dimension

Last updated: 2020-05-15 18:08:19

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 across a period of time.

To query the monitoring data of TKE service dimension, use the following input parameters:
&Namespace=QCE/DOCKER
&Instances.N.Dimensions.0.Name=clusterId
&Instances.N.Dimensions.0.Value=cluster 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, please see Common Params.

2.1 Input parameters

2.1.1. Overview of input 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 No String Common parameter, indicating the region of the instance to be queried. For supported regions, please see the list of regions supported by TKE
Namespace Yes String Namespace. Each Tencent Cloud service has a namespace, such as QCE/DOCKER for the TKE service dimension. This value must be capitalized for API 3.0
MetricName Yes String Metric name. For more information, please see section 2.2
Instances.N Yes Array of Instance Combination of instance object dimensions
Period No Integer Statistical period for monitoring data in seconds. Default value: 300
StartTime No Timestamp Start time, such as "2016-01-01 10:25:00". The default value is "00:00:00" of the current day
EndTime No Timestamp End time, which is the current time by default. endTime cannot be earlier than startTime

2.1.2. Overview of parameters in each dimension

Parameter Name Dimension Name Dimension Description Format
Instances.N.Dimensions.0.Name clusterId Cluster ID Enter a string-type dimension name, such as clusterId
Instances.N.Dimensions.0.Value clusterId A specific cluster ID, that is, the clusterId field returned by the cluster list query API Enter a specific cluster ID, such as cls-xxxxx
Instances.N.Dimensions.1.Name serviceName Service name Enter a string-type dimension name, such as serviceName
Instances.N.Dimensions.1.Value serviceName A specific service name, that is, the serviceName field returned by the service list query API Enter a specific service name, such as test
Instances.N.Dimensions.2.Name namespace Namespace name Enter a string-type dimension name, such as namespace
Instances.N.Dimensions.2.Value namespace A specific namespace name, that is, the namespace field returned by the service list query API Enter a specific namespace name, such as default

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.

Monitoring Item Metric Name Unit Description
Service CPU usage ServiceCpuUsed Core Total CPU usage of all container pods in the service
Service CPU utilization (for the cluster) ServiceCpuUsageForCluster % Service CPU utilization for the cluster
Service memory usage ServiceMemUsed MiB Total memory usage of all container pods in the service
Service memory utilization (for the cluster) ServiceMemUsageForCluster % Service memory utilization for the cluster
Service network inbound traffic ServiceInFlux MB Total inbound traffic of all pods in the service within the time window
Service network outbound traffic ServiceOutFlux MB Total outbound traffic of all pods in the service within the time window
Service network inbound bandwidth ServiceInBandwidth Mbps Total inbound bandwidth of all pods in the service
Service network outbound bandwidth ServiceOutBandwidth Mbps Total outbound bandwidth of all pods in the service
Service network inbound packets ServiceInPackets Packets/sec Total inbound packets of all pods in the service
Service network outbound packets ServiceOutPackets Packets/sec Total outbound packets of all pods in the service

3. Output Parameters

Parameter Name Type Description
MetricName String Monitoring metric
StartTime Timestamp Data point start time
EndTime Timestamp Data point end time
Period Integer Statistical period
DataPoints Array of PointsObject Monitoring data list
RequestId String Unique request ID. Each request returns a unique ID. RequestId is required to troubleshoot issues

4. Error Codes

Error Code Error Description Error Message
-502 The resource does not exist OperationDenied.SourceNotExists
-503 Incorrect request parameter InvalidParameter
-505 Missing parameter InvalidParameter.MissingParameter
-507 Limit exceeded OperationDenied.ExceedLimit
-509 Incorrect combination of dimensions InvalidParameter.DimensionGroupError
-513 Database operation failed InternalError.DBoperationFail

5. Samples

Sample 1

This example shows you how to get the monitoring data for the service CPU usage of one TKE service using a statistical period of 60 seconds for a specified length of time.

Sample input code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/DOCKER
&MetricName=ServiceCpuUsed
&Period=60
&StartTime=2019-06-17T16:35:00+08:00
&EndTime=2019-06-17T16:40:00+08:00
&Instances.0.Dimensions.0.Name=clusterId
&Instances.0.Dimensions.0.Value=cls-12345
&Instances.0.Dimensions.1.Name=namespace
&Instances.0.Dimensions.1.Value=default
&Instances.0.Dimensions.2.Name=serviceName
&Instances.0.Dimensions.2.Value=monitor
&<Common request parameters>

Sample output code

{
  "Response": {
    "StartTime": "2019-06-17 16:35:00",
    "EndTime": "2019-06-17 16:40:00",
    "Period": 60,
    "MetricName": "ServiceCpuUsed",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "clusterId",
            "Value": "cls-12345"
          },
          {
            "Name": "namespace",
            "Value": "default"
          },
          {
            "Name": "serviceName",
            "Value": "monitor"
          }
        ],
        "Timestamps": [
          1560760500,
          1560760560,
          1560760620,
          1560760680,
          1560760740,
          1560760800
        ],
        "Values": [
          0.000004,
          0.000002,
          0.000005,
          0.000001,
          0.000004,
          0.000002
        ]
      }
    ],
    "RequestId": "7dde43ca-9fba-4ef9-8973-d0007a7dc628"
  }
}

Sample 2

This example shows you how to get the monitoring data for the service CPU usage of multiple TKE services using a statistical period of 60 seconds for a specified length of time.

Sample input code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/DOCKER
&MetricName=ServiceCpuUsed
&Period=60
&StartTime=2019-06-17T16:35:00+08:00
&EndTime=2019-06-17T16:40:00+08:00
&Instances.0.Dimensions.0.Name=clusterId
&Instances.0.Dimensions.0.Value=cls-12345
&Instances.0.Dimensions.1.Name=namespace
&Instances.0.Dimensions.1.Value=default
&Instances.0.Dimensions.2.Name=serviceName
&Instances.0.Dimensions.2.Value=monitor
&Instances.1.Dimensions.0.Name=clusterId
&Instances.1.Dimensions.0.Value=cls-123456
&Instances.1.Dimensions.1.Name=namespace
&Instances.1.Dimensions.1.Value=default
&Instances.1.Dimensions.2.Name=serviceName
&Instances.1.Dimensions.2.Value=monitor
&<Common request parameters>

Sample output code

{
  "Response": {
    "StartTime": "2019-06-17 16:35:00",
    "EndTime": "2019-06-17 16:40:00",
    "Period": 60,
    "MetricName": "ServiceCpuUsed",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "clusterId",
            "Value": "cls-12345"
          },
          {
            "Name": "namespace",
            "Value": "default"
          },
          {
            "Name": "serviceName",
            "Value": "monitor"
          }
        ],
        "Timestamps": [
          1560760500,
          1560760560,
          1560760620,
          1560760680,
          1560760740,
          1560760800
        ],
        "Values": [
          0.000004,
          0.000002,
          0.000005,
          0.000001,
          0.000004,
          0.000002
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "clusterId",
            "Value": "cls-123456"
          },
          {
            "Name": "namespace",
            "Value": "default"
          },
          {
            "Name": "serviceName",
            "Value": "monitor"
          }
        ],
        "Timestamps": [
          1560760500,
          1560760560,
          1560760620,
          1560760680,
          1560760740,
          1560760800
        ],
        "Values": [
          0.000004,
          0.000002,
          0.000005,
          0.000001,
          0.000004,
          0.000002
        ]
      }
    ],
    "RequestId": "7dde43ca-9fba-4ef9-8973-d0007a7dc628"
  }
}