告警规则:查看详情v4.1 告警规则 告警规则:查看详情 接口功能介绍 查看告警规则的详情信息。 接口约束 regionID(资源池)和alarmRuleID(告警规则)存在。 URI GET /v4.1/monitor/describealarmrule 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleID 是 String 告警规则ID 3dbd23b274e253f8869c6fe6b07b9dba 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码(800为成功,900为失败),默认值:800 800 errorCode String 失败时的错误代码,参见公共错误码说明 message String 失败时的错误描述,一般为英文描述 Success msgDesc String 失败时的错误描述,一般为中文描述 成功 returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 alarmRule Object 告警规则 alarmRule 表 alarmRule 参数 参数类型 说明 示例 下级对象 regionID String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleID String 告警规则ID 3dbd23b274e253f8869c6fe6b07b9dba name String 规则名 告警规则名称 desc String 描述 描述 repeatTimes Integer 重复告警通知次数 1 service String 服务 ecs dimension String 维度 ecs silenceTime Integer 静默时间,单位:秒 300 recoverNotify Integer 本参数表示恢复是否通知。取值范围:0:否。1:是。根据以上范围取值。 0 notifyType Array of Strings 本参数表示告警接收策略。取值范围:email:邮件告警。sms:短信告警。根据以上范围取值。 ['email', 'sms'] contactGroupList Array of Objects 告警联系组 contactGroup notifyWeekdays Array of Integers 本参数表示通知周期。取值范围:0:周日。1:周一。2:周二。3:周三。4:周四。5:周五。6:周六。根据以上范围取值。 [0,1,2,3] notifyStart String 通知起始时段 00:00:00 notifyEnd String 通知结束时段 23:59:59 status Integer 本参数表示告警规则启用状态。取值范围:0:启用。1:停用。根据以上范围取值。 0 webhookUrl Array of Strings webhook消息推送url ['www.ctyun.cn'] resGroupID String 资源分组ID eec4a76a35ba57b891c6c4fd923351d6 createTime Integer 创建时间 1666855494 updateTime Integer 更新时间 1666856960 projectID String 项目ID 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 表 contactGroup 参数 参数类型 说明 示例 下级对象 groupID String 联系组ID 392c2sfcb05d5f5cae1c80c24c282090 name String 联系组名称 告警联系组 表 condition 参数 参数类型 说明 示例 下级对象 evaluationCount Integer 持续次数,当规则执行结果持续多久符合条件时报警(防抖),默认2次 2 metric String 监控指标 cpuutil 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。参数fun为last时不可传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围:m:分钟。h:小时。d:天。根据以上范围取值。 5m unit String 监控指标单位 bit 表 resources 参数 参数类型 说明 示例 下级对象 resource Array of Objects 资源信息 resource 表 resource 参数 参数类型 说明 示例 下级对象 name String 资源实例标签键 uuid value String 资源实例标签值 000f03221f4d8cc8bb2e1c30fb751aa5 表 dimensions 参数 参数类型 说明 示例 下级对象 name String 自定义监控资源实例标签键 uuid value Array of Strings 自定义监控资源实例标签值 ['1c30fb751aa5']
来自: