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

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

查询告警历史

请注意,如果使用子用户进行告警历史的查询,只能查询到被授权项目下的告警历史,或不区分项目的产品的告警历史。如何对子账户授予项目的权限,请参考 访问管理-项目与标签

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAlarmHistories。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 固定值,为"monitor"
示例值:monitor
PageNumber Integer 页数,从 1 开始计数,默认 1
示例值:1
PageSize Integer 每页的数量,取值1~100,默认20
示例值:20
Order String 默认按首次出现时间倒序排列 "ASC"=正序 "DESC"=逆序
示例值:DESC
StartTime Integer 起始时间,默认一天前的时间戳。对应 FirstOccurTime 告警首次出现时间,告警历史的 FirstOccurTime 晚于 StartTime 才可能被搜索到。
示例值:1611600000
EndTime Integer 结束时间,默认当前时间戳。对应 FirstOccurTime 告警首次出现时间,告警历史的 FirstOccurTime 早于 EndTime 才可能被搜索到。
示例值:1611650000
MonitorTypes.N Array of String 根据监控类型过滤,不选默认查所有类型。"MT_QCE"=云产品监控,支持的枚举值有:"MT_QCE"=云产品监控;"MT_TAW"=应用性能监控;"MT_RUM"=前端性能监控;"MT_PROBE"=云拨测
示例值:MT_QCE
AlarmObject String 根据告警对象过滤 字符串模糊搜索
示例值:tdsqlshard-h2phzy69
AlarmStatus.N Array of String 根据告警状态过滤 ALARM=未恢复 OK=已恢复 NO_CONF=已失效 NO_DATA=数据不足,不选默认查所有
示例值:ALARM
ProjectIds.N Array of Integer 根据项目ID过滤,-1=无项目 0=默认项目
可在此页面查询 项目管理
InstanceGroupIds.N Array of Integer 根据实例组ID过滤
Namespaces.N Array of MonitorTypeNamespace 根据策略类型过滤,策略类型是监控类型之下的概念,在这里两者都需要传入,例如 [{"MonitorType": "MT_QCE", "Namespace": "cvm_device"}]
可使用 查询所有名字空间 DescribeAllNamespaces 接口查询
示例值:[{"MonitorType": "MT_QCE", "Namespace": "cvm_device"}]
MetricNames.N Array of String 根据指标名过滤
示例值:CpuUsage
取值可参考:
查询告警指标列表
PolicyName String 根据策略名称模糊搜索,不支持大小写区分
Content String 根据告警内容模糊搜索
ReceiverUids.N Array of Integer 根据接收人搜索,可以使用“访问管理”的 拉取子用户 ListUsers 接口获取用户列表 或 查询子用户 GetUser 接口查询子用户详情,此处填入返回结果中的 Uid 字段
ReceiverGroups.N Array of Integer 根据接收组搜索,可以使用“访问管理”的 查询用户组列表 ListGroups 接口获取用户组列表 或 列出用户关联的用户组 ListGroupsForUser 查询某个子用户所在的用户组列表 ,此处填入返回结果中的 GroupId 字段
PolicyIds.N Array of String 根据告警策略 Id 列表搜索
示例值:policy-abcedf
AlarmLevels.N Array of String 告警等级,取值范围:Remind、Serious、Warn
示例值:["Warn"]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数
示例值:100
Histories Array of AlarmHistory 告警历史列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询告警历史

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmHistories
<公共请求参数>

{
    "Module": "monitor",
    "PageNumber": 1,
    "PageSize": 10,
    "StartTime": 1598976507,
    "EndTime": 1599019707
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Histories": [
            {
                "AlarmId": "abc",
                "MonitorType": "abc",
                "Namespace": "abc",
                "AlarmObject": "abc",
                "Content": "abc",
                "FirstOccurTime": 0,
                "LastOccurTime": 0,
                "AlarmStatus": "abc",
                "PolicyId": "abc",
                "PolicyName": "abc",
                "VPC": "abc",
                "ProjectId": 0,
                "ProjectName": "abc",
                "InstanceGroup": [
                    {
                        "Id": 0,
                        "Name": "abc"
                    }
                ],
                "ReceiverUids": [
                    0
                ],
                "ReceiverGroups": [
                    0
                ],
                "NoticeWays": [
                    "abc"
                ],
                "OriginId": "abc",
                "AlarmType": "abc",
                "EventId": 0,
                "Region": "abc",
                "PolicyExists": 0,
                "MetricsInfo": [
                    {
                        "QceNamespace": "abc",
                        "MetricName": "abc",
                        "Period": 0,
                        "Value": "abc",
                        "Description": "abc"
                    }
                ],
                "Dimensions": "abc",
                "AlarmLevel": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

示例2 查询“云服务器-基础监控”的告警历史

监控类型是一级概念,策略类型是二级概念,因此在 Namespaces 字段中只有在指定监控类型后,策略类型才有意义。

如果要查询“云服务器-基础监控”的告警历史,这里的过滤条件应为:监控类型=“云产品监控”,策略类型=“云服务器-基础监控”

MonitorTypes 作为一级过滤条件应填入 ["MT_QCE"]

Namespaces 作为二级过滤条件应填入 [{"MonitorType": "MT_QCE", "Namespace": "cvm_device"}]

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmHistories
<公共请求参数>

{
    "Module": "monitor",
    "PageNumber": 1,
    "PageSize": 10,
    "StartTime": 1598976507,
    "EndTime": 1599019707,
    "MonitorTypes": [
        "MT_QCE"
    ],
    "Namespaces": [
        {
            "MonitorType": "MT_QCE",
            "Namespace": "cvm_device"
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Histories": [
            {
                "AlarmId": "abc",
                "MonitorType": "abc",
                "Namespace": "abc",
                "AlarmObject": "abc",
                "Content": "abc",
                "FirstOccurTime": 0,
                "LastOccurTime": 0,
                "AlarmStatus": "abc",
                "PolicyId": "abc",
                "PolicyName": "abc",
                "VPC": "abc",
                "ProjectId": 0,
                "ProjectName": "abc",
                "InstanceGroup": [
                    {
                        "Id": 0,
                        "Name": "abc"
                    }
                ],
                "ReceiverUids": [
                    0
                ],
                "ReceiverGroups": [
                    0
                ],
                "NoticeWays": [
                    "abc"
                ],
                "OriginId": "abc",
                "AlarmType": "abc",
                "EventId": 0,
                "Region": "abc",
                "PolicyExists": 0,
                "MetricsInfo": [
                    {
                        "QceNamespace": "abc",
                        "MetricName": "abc",
                        "Period": 0,
                        "Value": "abc",
                        "Description": "abc"
                    }
                ],
                "Dimensions": "abc",
                "AlarmLevel": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.DoHTTPTransferFailed 后端服务超时
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
UnsupportedOperation 操作不支持。