1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
查询告警指标列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAlarmMetrics。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Module | 是 | String | 固定值,为"monitor" 示例值:monitor |
| MonitorType | 是 | String | 监控类型过滤 "MT_QCE"=云产品监控 示例值:MT_QCE |
| Namespace | 是 | String | 告警策略类型,由 DescribeAllNamespaces 获得,例如 cvm_device 示例值:cvm_device |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Metrics | Array of Metric | 告警指标列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询告警指标列表
查询“云服务器-基础监控”的告警指标列表
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmMetrics
<公共请求参数>
{
"Module": "monitor",
"MonitorType": "MT_QCE",
"Namespace": "cvm_device"
}
输出示例
{
"Response": {
"Metrics": [
{
"Description": "CPU利用率",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "CpuUsage",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "%"
},
{
"Description": "基础CPU利用率",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "BaseCpuUsage",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "%"
},
{
"Description": "内存利用率",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "MemUsage",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "%"
},
{
"Description": "内存使用量",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "MemUsed",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "MB"
},
{
"Description": "磁盘利用率",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "CvmDiskUsage",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "%"
},
{
"Description": "磁盘读流量(适用于i3机型)",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "DiskReadTraffic",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "KB/s"
},
{
"Description": "磁盘写流量(适用于i3机型)",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "DiskWriteTraffic",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "KB/s"
},
{
"Description": "磁盘IO等待(适用于i3机型)",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 3600000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "DiskIoAwait",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "毫秒"
},
{
"Description": "内网入包量",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "LanInpkg",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "个/秒"
},
{
"Description": "内网出包量",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "LanOutpkg",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "个/秒"
},
{
"Description": "外网入带宽",
"Dimensions": [
"InstanceId"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 10000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "WanIntraffic",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "Mbps"
},
{
"Description": "外网出带宽",
"Dimensions": [
"InstanceId"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 10000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "WanOuttraffic",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "Mbps"
},
{
"Description": "外网入包量",
"Dimensions": [
"InstanceId"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "WanInpkg",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "个/秒"
},
{
"Description": "外网出包量",
"Dimensions": [
"InstanceId"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "WanOutpkg",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "个/秒"
},
{
"Description": "外网出带宽使用率",
"Dimensions": [
"InstanceId"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 100,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "Outratio",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "%"
},
{
"Description": "TCP连接数",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 10000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "TcpCurrEstab",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "个"
},
{
"Description": "内网入带宽",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 10000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "LanIntraffic",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "Mbps"
},
{
"Description": "内网出带宽",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 10000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "LanOuttraffic",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "Mbps"
},
{
"Description": "CPU一分钟平均负载",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "CpuLoadavg",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": ""
},
{
"Description": "CPU五分钟平均负载",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "Cpuloadavg5m",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": ""
},
{
"Description": "CPU十五分钟平均负载",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "Cpuloadavg15m",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": ""
},
{
"Description": "子机utc时间和ntp时间差值",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 10000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60
]
},
"MetricName": "Timeoffset",
"Min": -100,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "s"
},
{
"Description": "连接跟踪丢包",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 10000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "NfctDrop",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "Count"
},
{
"Description": "插入失败",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 10000000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"no_data"
],
"Period": [
60,
300
]
},
"MetricName": "NfctInsertFail",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "Count"
},
{
"Description": "用户实际使用内存",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1000000,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"day_increase",
"day_decrease",
"week_increase",
"week_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave",
"day_wave",
"week_wave"
],
"Period": [
60,
300
]
},
"MetricName": "MemTotalUsed",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "MB"
},
{
"Description": "GPU_nvidia_smi命令卡住",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave"
],
"Period": [
300
]
},
"MetricName": "GpuNvidiaHung",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "None"
},
{
"Description": "Nvidia_fabricmanager服务状态",
"Dimensions": [
"vm_uuid"
],
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 0,
"Max": 1,
"MetricConfig": {
"ContinuePeriod": [
1,
2,
3,
4,
5
],
"Operator": [
"cycle_increase",
"cycle_decrease",
"gt",
"ge",
"lt",
"le",
"eq",
"ne",
"cycle_wave"
],
"Period": [
300
]
},
"MetricName": "FabricmanagerService",
"Min": 0,
"Namespace": "cvm_device",
"Operators": [],
"Periods": null,
"ProductId": 0,
"Unit": "None"
}
],
"RequestId": "3e097fc4-5fb5-4105-bdc9-d466e021e83c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DoHTTPTransferFailed | 后端服务超时 |
| FailedOperation.DoTRPCTransferFailedWithCorruptionData | 网络调用报错 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |