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 container dimension, use the following input parameters:
&Namespace=QCE/DOCKER
&Instances.N.Dimensions.0.Name=clusterId
&Instances.N.Dimensions.0.Value=cluster ID
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.
| 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 container 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 |
| 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 |
| Instances.N.Dimensions.3.Name | podName | Pod name | Enter a string-type dimension name, such as podName |
| Instances.N.Dimensions.3.Value | podName | A specific pod name, that is, the name field returned by the service instance list query API |
Enter a specific pod name, such as test-3488000495-nj6s9 |
| Instances.N.Dimensions.4.Name | containerId | Container ID | Enter a string-type dimension name, such as containerId |
| Instances.N.Dimensions.4.Value | containerId | A specific container ID, that is, the containerId field returned by the service instance list query API. Note that it is sufficient to take the first 12 characters of the container ID for this parameter |
Enter a specific container name, such as 01c5509d2b39 |
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 |
|---|---|---|---|
| Container CPU usage | ContainerCpuUsed | Core | CPU usage of the container |
| Container CPU utilization (for nodes) | ContainerCpuUsageForNode | % | Container CPU utilization for nodes |
| Container CPU utilization (for requests) | ContainerCpuUsageForRequest | % | Container CPU utilization for requests |
| Container CPU utilization (for the limit) | ContainerCpuUsageForLimit | % | Container CPU utilization for the limit |
| Container memory usage | ContainerMemUsed | MiB | Used container memory |
| Container memory utilization (for nodes) | ContainerMemUsageForNode | % | Container memory utilization for nodes |
| Container memory utilization (for requests) | ContainerMemUsageForRequest | % | Container memory utilization for requests |
| Container memory utilization (for the limit) | ContainerMemUsageForLimit | % | Container memory utilization for the limit |
| Container disk read traffic | ContainerDiskReadTraffic | KB/sec | Disk read traffic when the container reads from the disk |
| Container disk write traffic | ContainerDiskWriteTraffic | KB/sec | Disk write traffic when the container writes to the disk |
| Container disk read IOPS | ContainerDiskRead | Count | Read IOPS when the container reads from the disk |
| Container disk write IOPS | ContainerDiskWrite | Count | Write IOPS when the container writes to the disk |
| 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 |
| 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 |
This example shows you how to get the monitoring data for the container CPU usage of one TKE container using a statistical period of 60 seconds for a specified length of time.
https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/DOCKER
&MetricName=ContainerCpuUsed
&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.0.Dimensions.3.Name=podName
&Instances.0.Dimensions.3.Value=monitor-68b6db4956-12345
&Instances.0.Dimensions.4.Name=containerId
&Instances.0.Dimensions.4.Value=abcd1234efg
&<Common request parameters>{
"Response": {
"StartTime": "2019-06-17 16:35:00",
"EndTime": "2019-06-17 16:40:00",
"Period": 60,
"MetricName": "ContainerCpuUsed",
"DataPoints": [
{
"Dimensions": [
{
"Name": "clusterid",
"Value": "cls-12345"
},
{
"Name": "containerId",
"Value": "abcd1234efg"
},
{
"Name": "namespace",
"Value": "default"
},
{
"Name": "podName",
"Value": "monitor-68b6db4956-12345"
},
{
"Name": "serviceName",
"Value": "monitor"
}
],
"Timestamps": [
1560760500,
1560760560,
1560760620,
1560760680,
1560760740,
1560760800
],
"Values": [
0,
0,
0,
0,
0,
0
]
}
],
"RequestId": "3a0008c9-ecc6-48aa-9033-8f37144cc816"
}
}This example shows you how to get the monitoring data for the container CPU usage of multiple TKE containers using a statistical period of 60 seconds for a specified length of time.
https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/BLOCK_STORAGE
&MetricName=ContainerCpuUsed
&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.0.Dimensions.3.Name=podName
&Instances.0.Dimensions.3.Value=monitor-68b6db4956-12345
&Instances.0.Dimensions.4.Name=containerId
&Instances.0.Dimensions.4.Value=abcd1234efg
&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
&Instances.1.Dimensions.3.Name=podName
&Instances.1.Dimensions.3.Value=monitor-68b6db4956-12345
&Instances.1.Dimensions.4.Name=containerId
&Instances.1.Dimensions.4.Value=abcd1234efg
&<Common request parameters>{
"Response": {
"StartTime": "2019-06-17 16:35:00",
"EndTime": "2019-06-17 16:40:00",
"Period": 60,
"MetricName": "ContainerCpuUsed",
"DataPoints": [
{
"Dimensions": [
{
"Name": "clusterId",
"Value": "cls-12345"
},
{
"Name": "containerId",
"Value": "abcd1234efg"
},
{
"Name": "namespace",
"Value": "default"
},
{
"Name": "podName",
"Value": "monitor-68b6db4956-12345"
},
{
"Name": "serviceName",
"Value": "monitor"
}
],
"Timestamps": [
1560760500,
1560760560,
1560760620,
1560760680,
1560760740,
1560760800
],
"Values": [
0,
0,
0,
0,
0,
0
]
},
{
"Dimensions": [
{
"Name": "clusterid",
"Value": "cls-123456"
},
{
"Name": "containerId",
"Value": "abcd1234efg"
},
{
"Name": "namespace",
"Value": "default"
},
{
"Name": "podName",
"Value": "monitor-68b6db4956-12345"
},
{
"Name": "serviceName",
"Value": "monitor"
}
],
"Timestamps": [
1560760500,
1560760560,
1560760620,
1560760680,
1560760740,
1560760800
],
"Values": [
0,
0,
0,
0,
0,
0
]
}
],
"RequestId": "3a0008c9-ecc6-48aa-9033-8f37144cc816"
}
}
Was this page helpful?