1. 接口描述
接口请求域名: monitor.api3.fincloud.tencent.cn。
查询告警指标列表
默认接口请求频率限制:20次/秒。
接口更新时间:2022-11-16 10:17:56。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeAlarmMetrics |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-07-24 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| 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。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
5. 示例
示例1 查询告警指标列表
查询“云服务器-基础监控”的告警指标列表
输入示例
POST / HTTP/1.1
Host: monitor.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeAlarmMetrics
<公共请求参数>
{"Module":"monitor","MonitorType":"MT_QCE","Namespace":"cvm_device"}
https://monitor.api3.fincloud.tencent.cn/?Action=DescribeAllNamespaces&Module="monitor"&SceneType="1598976507"&Namespace="1598976507"&MonitorTypes="1000000"
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "92hg92hj1-2h352h25hj-2h235h",
"Metrics": [
{
"Namespace": "cvm_device",
"MetricName": "cpu_usage",
"Description": "CPU使用率",
"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]
}
}
]
}
}