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

1. 接口描述

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

获取基础告警列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBasicAlarmList。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 接口模块名,当前取值monitor
示例值:monitor
StartTime Integer 起始时间,默认一天前的时间戳
示例值:1573660800
EndTime Integer 结束时间,默认当前时间戳
示例值:1573919999
Limit Integer 分页参数,每页返回的数量,取值1~100,默认20
示例值:20
Offset Integer 分页参数,页偏移量,从0开始计数,默认0
示例值:0
OccurTimeOrder String 根据发生时间排序,取值ASC或DESC
示例值:DESC
ProjectIds.N Array of Integer 根据项目ID过滤
示例值:["0\n"]
ViewNames.N Array of String 根据策略类型过滤
示例值:["cvm_device\n"]
AlarmStatus.N Array of Integer 根据告警状态过滤
示例值:["1\n"]
ObjLike String 根据告警对象过滤
示例值:123
InstanceGroupIds.N Array of Integer 根据实例组ID过滤
示例值:[11233]
MetricNames.N Array of String 根据指标名过滤
示例值:["mem_used\n"]

3. 输出参数

参数名称 类型 描述
Alarms Array of DescribeBasicAlarmListAlarms 告警列表
注意:此字段可能返回 null,表示取不到有效值。
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Warning String 备注信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:This method is deprecated! Use DescribeAlarmHistories instead!
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取基础告警列表

输入示例

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

{
    "AlarmStatus": [
        "1"
    ],
    "MetricNames": [
        "mem_used"
    ],
    "Module": "monitor",
    "ViewNames": [
        "cvm_device"
    ],
    "Limit": "20",
    "StartTime": "1573660800",
    "Offset": "0",
    "ProjectIds": [
        "0"
    ],
    "EndTime": "1573919999",
    "OccurTimeOrder": "DESC"
}

输出示例

{
    "Response": {
        "Alarms": [
            {
                "AlarmStatus": "OK",
                "AlarmType": "内存使用量",
                "Content": "内存使用量 >  66666 MB",
                "Dimensions": "{\"unInstanceId\":\"ins-19a06nn8\"}",
                "Duration": 600,
                "FirstOccurTime": "2019-11-16T15:50:00+08:00",
                "GroupId": 1278966,
                "GroupName": "dddd",
                "Id": 30057956,
                "InstanceGroup": [
                    {
                        "InstanceGroupId": 562,
                        "InstanceGroupName": "barad_nws_cvm"
                    }
                ],
                "LastOccurTime": "2019-11-16T16:00:00+08:00",
                "MetricId": 24,
                "MetricName": "mem_used",
                "NotifyWay": [
                    "EMAIL",
                    "SMS"
                ],
                "ObjId": "a961c198-e0e2-4989-a3b6-7b155b35ff6f",
                "ObjName": "10.0.0.14(251008737 vm1)",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "Region": "gz",
                "Status": 1,
                "ViewName": "cvm_device",
                "Vpc": "1"
            },
            {
                "AlarmStatus": "OK",
                "AlarmType": "内存使用量",
                "Content": "内存使用量 >=  200000 MB",
                "Dimensions": "{\"unInstanceId\":\"ins-19a06nn8\"}",
                "Duration": 180,
                "FirstOccurTime": "2019-11-16T15:45:00+08:00",
                "GroupId": 1279043,
                "GroupName": "-",
                "Id": 30057955,
                "InstanceGroup": [
                    {
                        "InstanceGroupId": 562,
                        "InstanceGroupName": "barad_nws_cvm"
                    }
                ],
                "LastOccurTime": "2019-11-16T15:48:00+08:00",
                "MetricId": 24,
                "MetricName": "mem_used",
                "NotifyWay": [
                    "EMAIL",
                    "SMS",
                    "WECHAT"
                ],
                "ObjId": "a961c198-e0e2-4989-a3b6-7b155b35ff6f",
                "ObjName": "10.0.0.14(251008737 vm1)",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "Region": "gz",
                "Status": 1,
                "ViewName": "cvm_device",
                "Vpc": "1"
            }
        ],
        "RequestId": "6b64cc24-0c60-483f-bdc3-2e55edbbc68c",
        "Total": 2,
        "Warning": "This method is deprecated! Use `DescribeAlarmHistories` instead!"
    }
}

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 操作不支持。