查询告警历史

1. 接口描述

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

查询告警历史

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

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

2. 输入参数

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

3. 输出参数

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。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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