接口功能介绍

根据筛选项查询告警规则列表。

接口约束

regionID（资源池）存在。

URI

GET /v4.1/monitor/query-alarm-rules

路径参数 无

Query参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
service	否	String	本参数表示服务。取值范围： ecs：云主机。 evs：云硬盘。 pms：物理机。 ... 详见"云监控：查询服务维度及监控项"接口返回。	ecs
alarmStatus	否	Integer	本参数表示告警规则是否告警。取值范围： 0：未触发告警。 1：触发告警。 2：无数据。根据以上范围取值。	1
status	否	Integer	本参数表示告警规则状态。取值范围： 0：启用。 1：停用。根据以上范围取值。	1
name	否	String	规则名称（模糊查询）	告警规则名称
contactGroupName	否	String	告警联系组名（模糊查询）	联系组
instanceName	否	String	监控对象名称（模糊查询）	vpc-vpc2913
sortKey	否	String	排序字段	updateTime
sortType	否	String	排序类型。取值范围： ASC：升序。 DESC：降序。根据以上范围取值。	ASC
pageNo	否	Integer	页码，默认值：1	1
pageSize	否	Integer	页大小，默认值：20	10
resGroupID	否	String	资源分组ID	eec4a76a-35ba-57b8-91c6-c4fd923351d6

请求参数

请求头header参数 无

请求体body参数 无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败），默认值：800	800
errorCode	String	失败时的错误代码，参见公共错误码说明
message	String	失败时的错误描述，一般为英文描述	Success
msgDesc	String	失败时的错误描述，一般为中文描述	成功
description	String	失败时的错误描述，适配中英文	成功
returnObj	Object	返回对象		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
totalCount	Integer	总记录数	20
page	Integer	当前页记录数	1
pageSize	Integer	页大小	2
alarmRules	Array of Objects			alarmRules

表 alarmRules

参数	参数类型	说明	示例	下级对象
regionID	String	资源池ID	81f7728662dd11ec810800155d307d5b
alarmRuleID	String	告警规则ID	3dbd23b2-74e2-53f8-869c-6fe6b07b9dba
name	String	告警规则名称	cpu_alarm_rule
desc	String	告警规则描述	云主机告警规则
repeatTimes	Integer	重复告警通知次数	1
service	String	服务	ecs
dimension	String	维度
silenceTime	Integer	静默时间，单位：秒
recoverNotify	Integer	本参数表示恢复是否通知。取值范围： 0：否。 1：是。根据以上范围取值。
notifyType	Array of Strings	本参数表示告警接收策略。取值范围： email：邮件告警。 sms：短信告警。根据以上范围取值。	email
contactGroupList	Array of Objects	告警联系组		contactGroupList
notifyWeekdays	Array of Integers	本参数表示通知周期。取值范围： 0：周日。 1：周一。 2：周二。 3：周三。 4：周四。 5：周五。 6：周六。根据以上范围取值。	0
notifyStart	String	通知起始时段	00:00:00
notifyEnd	String	通知结束时段	23:59:59
status	Integer	本参数表示告警规则启用状态。取值范围： 0：启用。 1：停用。根据以上范围取值。
webhookUrl	Array of Strings	webhook消息推送url	www.ctyun.cn
resGroupID	String	资源分组ID
createTime	Long	创建时间	1666855494
updateTime	Long	更新时间	1666856960
projectID	String	项目ID	c4fd923351d6
resources	Array of Objects	具体匹配资源		resources
condition	Array of Objects	触发规则的条件		condition
dimensions	Array of Objects	自定义监控信息，仅支持部分资源池		dimensions
conditionType	Integer	本参数表示告警策略触发类型。取值范围： 0：或，任一条件触发。 1：全部条件满足触发。根据以上范围取值。	0
alarmStatus	Integer	本参数表示告警规则是否告警。取值范围： 0：未触发告警。 1：触发告警。 2：无数据（仅部分资源池支持）。根据以上范围取值。	1
alarmType	String	告警规则类型。取值范围： series：时序类监控。 event：事件类。根据以上范围取值。	1
project	String	告警规则来源	console
resourceScope	Integer	规则的资源范围，取值范围： 0：实例资源类型。 1：资源分组类型。 2：全部资源类型。根据以上范围取值。	0
defaultContact	Integer	是否使用天翼云默认联系人接收通知，取值范围： 0：否。 1：是。根据以上范围取值。	0
noticeStrategyID	String	通知策略ID	3ec4a76a-35ba-57b8-91c6-c4fd923351d6

表 contactGroupList

参数	参数类型	说明	示例	下级对象
groupID	String	联系组ID	392c2sfc-b05d-5f5c-ae1c-80c24c282090
name	String	联系组名称	紧急告警联系组

表 resources

参数	参数类型	说明	示例	下级对象
resource	Array of Objects			resource

表 resource

参数	参数类型	说明	示例	下级对象
name	String	资源实例标签键	uuid
value	String	资源实例标签值	000f0322-1f4d-8cc8-bb2e-1c30fb751aa5

表 condition

参数	参数类型	说明	示例
evaluationCount	Integer	持续次数，当规则执行结果持续多久符合条件时报警（防抖），默认2次	2
metric	String	监控指标	cpu_util
metricCnName	String	监控指标中文名	cpu使用率
fun	String	本参数表示告警采用算法。取值范围： last：原始值算法。 avg：平均值算法。 max：最大值算法。 min：最小值算法。根据以上范围取值。	avg
operator	String	本参数表示比较符。取值范围： eq：等于。 gt：大于。 ge：大于等于。 lt：小于。 le：小于等于。 rg：环比上升。 cf：环比下降。 rc：环比变化。根据以上范围取值。	eq
value	String	告警阈值，可以是整数、小数或百分数格式字符串	0
period	String	本参数表示算法统计周期。默认值5m。本参数格式为“数字+单位”。单位取值范围： m：分钟。 h：小时。 d：天。根据以上范围取值。	5m
unit	String	监控指标单位	bit
level	Integer	本参数表示告警等级。取值范围： 1：紧急。 2：警示。 3：普通。根据以上范围取值	3

表 dimensions

参数	参数类型	说明	示例	下级对象
name	String	自定义监控资源实例标签键	uuid
value	Array of Strings	自定义监控资源实例标签值	1c30fb751aa5

枚举参数

无

请求示例

请求url

/v4.1/monitor/query-alarm-rules?regionID=81f7728662dd11ec810800155d307d5b&alarmStatus=2&page=1&pageSize=1

请求头header

无

请求体body

无

响应示例

{
    "statusCode": 800,
    "returnObj": {
        "alarmRules": [
            {
                "alarmRuleID": "35809ee8-223c-538e-8981-90943405e866",
                "alarmStatus": "1",
                "alarmType": "series",
                "condition": [
                    {
                        "evaluationCount": 1,
                        "fun": "last",
                        "metric": "vpn_gw_in_bps",
                        "metricCnName": "VPN网关入方向流量速率",
                        "operator": "ge",
                        "period": "",
                        "unit": "bps",
                        "value": "0",
                        "level": 2
                    }
                ],
                "conditionType": 1,
                "contactGroupList": [
                    {
                        "groupID": "fe7f0cdc-4692-5516-8d3a-b06355482090",
                        "name": "告警组"
                    }
                ],
                "createTime": 1718594934,
                "desc": "告警规则描述",
                "dimension": "ipsec_vpn_gw_stats",
                "dimensions": [
                ],
                "name": "告警规则名称",
                "notifyEnd": "23:59:59",
                "notifyStart": "00:00:00",
                "notifyType": [
                    "email"
                ],
                "notifyWeekdays": [
                    0,
                    1,
                    2,
                    3,
                    4,
                    5,
                    6
                ],
                "project": "console",
                "projectID": "0",
                "recoverNotify": 0,
                "regionID": "81f7728662dd11ec810800155d307d5b",
                "repeatTimes": 0,
                "resGroupID": "",
                "resources": [
                    {
                        "resource": [
                            {
                                "name": "vpn_gateway_id",
                                "value": "614aa3b0-b232-4eb6-8b5a-5be0345e8108"
                            },
                            {
                                "name": "instancename",
                                "value": "vpn-gateway-a019"
                            }
                        ]
                    }
                ],
                "service": "ipsec_vpn",
                "silenceTime": 300,
                "status": 0,
                "resourceScope": 0,
                "defaultContact": 0,
                "updateTime": 1718594934,
                "webhookUrl": [
                ]
            }
        ],
        "totalCount": 1,
        "page": 1,
        "pageSize": 10
    },
    "errorCode": "",
    "message": "Success",
    "msgDesc": "成功",
    "description": "成功"
}

状态码

请参考状态码

错误码

请参考错误码

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云监控服务

云监控服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云监控服务

云监控服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码