Release Notes
Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to query the list of alarm metrics.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeAlarmMetrics. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
| Region | No | String | Common Params. This parameter is not required. |
| Module | Yes | String | Value fixed at "monitor" |
| MonitorType | Yes | String | Monitor type filter. Valid values: MT_QCE (Tencent Cloud service monitoring) |
| Namespace | Yes | String | Alarm policy type such as cvm_device, which is obtained through the DescribeAllNamespaces API |
| Parameter Name | Type | Description |
|---|---|---|
| Metrics | Array of Metric | Alarm metric list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the list of alarm metrics for "CVM - basic monitoring".
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmMetrics
<Common request parameters>
{
"Module": "monitor",
"MonitorType": "MT_QCE",
"Namespace": "cvm_device"
}{
"Response": {
"RequestId": "92hg92hj1-2h352h25hj-2h235h",
"Metrics": [
{
"Namespace": "cvm_device",
"MetricName": "cpu_usage",
"Description": "CPU utilization",
"Max": 100,
"Min": 0,
"Dimensions": [
"InstanceId",
"UUID"
],
"Unit": "%",
"MetricConfig": {
"Operator": [
"gt",
"ge",
"lt",
"le",
"eq",
"ne"
],
"Period": [
60,
300
],
"ContinuePeriod": [
1,
2,
3,
4,
5
]
}
}
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.DoHTTPTransferFailed | Backend service timed out. |
| ResourceNotFound | The resource is not found. |
| UnsupportedOperation | Unsupported operation. |
文档反馈