有奖捉虫:云通信与企业服务文档专题,速来> HOT

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"
MonitorType String 监控类型过滤 "MT_QCE"=云产品监控
Namespace String 告警策略类型,由 DescribeAllNamespaces 获得,例如 cvm_device

3. 输出参数

参数名称 类型 描述
Metrics Array of Metric 告警指标列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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": {
        "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
                    ]
                }
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DoHTTPTransferFailed 后端服务超时
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。