-
URI GET /v2/{project_id}/alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 正则匹配：^[a-zA-Z0-9-]{1,64}$ 表2 Query参数 参数 是否必选 参数类型 描述 alarm_id 否 String 告警规则ID 正则匹配：^al([0-9A-Za-z]){22}$ name 否 String 告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字，长度1-128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ namespace 否 String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” 正则匹配：^((([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*)|)$ resource_id 否 String 告警资源ID，多维度情况按字母升序排列并使用逗号分隔 正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|:|,|\.|)+$ enterprise_project_id 否 String 企业项目ID 正则匹配：^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ product_name 否 String 产品层级跨纬规则查询时支持产品名称查询，一般由"服务命名空间,服务首层维度名称"组成，如"SYS.E
CS ,instance_id" resource_level 否 String 产品层级跨纬规则查询时支持规则所属类型查询，resource_level取值为product即为产品层级跨纬规则，不填或者取值为dimension则为旧的规则类型 枚举值： product dimension offset 否 Integer 分页偏移量 取值范围： 0-10000 默认取值： 0 正则匹配：^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$ limit 否 Integer 分页大小 取值范围： 1-100 默认取值： 10 正则匹配：^([1-9]|[1-9][0-9]|100)$
-
响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 alarms Array of alarms objects 告警规则列表 count Integer 告警规则列表总数 取值范围： 0-1000 表5 alarms 参数 参数类型 描述 alarm_id String 告警规则ID 正则匹配：^al([0-9A-Za-z]){22}$ name String 告警规则名称 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ description String 告警规则描述 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
-
URI GET /v2/{project_id}/alarm-templates/{template_id}/association-alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID template_id 是 String 告警模板的ID，以at开头，后跟字母、数字，长度最长为64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询时查询的起始位置，表示从第几条数据开始，默认为0 取值范围： 0-10000 limit 否 Integer 查询结果条数的限制值，取值范围为[1,100]，默认值为100 取值范围： 1-100
-
约束与限制 当指标告警规则的状态（正常、超限阈值、生效中、停用中）发生变化时，如需使用企业微信、钉钉、飞书、语音、welink、邮件或短信等方式发送通知，请参考创建
AOM 告警通知规则设置告警通知规则。 按全量指标和按Prometheus命令创建指标告警规则时支持秒级监控，指标告警的时效性取决于指标上报周期、规则检查频率及通知发送耗时。 系统支持创建的指标告警规则、事件告警规则、应用性能监控告警规则总计不能超过3000条。 使用智能告警功能创建指标告警规则时，需要注意以下约束与限制： 智能告警功能当前仅在部分区域受限开放，如有需求可以通过提交工单，为您开放此功能。 使用智能告警监控新接入的指标时，指标的数据量不足时没有结果，需要采集足够的数据量才会有结果。 使用智能告警功能创建指标告警规则时，如果1个指标中有多条资源时间线，智能告警功能只会对指标最多的5条资源时间线生效。 同一个租户在多个区域使用智能告警功能创建多个指标告警规则时，所有告警规则中监控的指标总数最多为30个，并且智能告警功能最多支持检测150条资源时间线。 使用智能告警功能创建指标告警规则时，如果用户的指标名称过长或指标标签数量过多，会导致智能告警上报的指标入库失败，对智能告警产生影响。
-
告警规则标签说明 告警规则标签可应用于告警降噪模块的分组规则、抑制规则和静默规则，告警管理系统根据标签属性进行告警管理和通知。 告警规则标签为key:value键值对格式，支持用户自定义。您最多可创建20个自定义标签。key和value只能包含中文、字母、数字和下划线。 如果在创建告警规则时设置了告警规则标签，触发的告警会自动添加该标签为告警属性。 消息模板中通过$event.metadata.key1变量获取告警标签信息，具体请参见消息模板变量说明。 如您的组织已经设定AOM服务的相关标签策略，则需按照标签策略规则添加告警标签。标签如果不符合标签策略的规则，则可能会导致添加标签失败，请联系组织管理员了解标签策略详情。
-
约束与限制 仅开通了
云监控 CES融合功能才支持“一键告警”功能。当前云监控
CES 融合功能受限开放，如有需求可以通过提交工单，为您开放此功能。 如果需要在AOM控制台中使用云监控CES的功能，需要提前获取CES的相关权限，详情请参见CES权限管理。 AOM 2.0融合CES相关功能后，会向AOM FullAccess策略中添加“CES:*:*”，“ecs:instance:list”，“dms:instance:list”，“dms:instance:get”，“lts:topics:list”，“lts:groups:list”，“smn:topic:list”，“smn:topic:publish”，“swr:repository:*”，“swr:repo:*”，“vpc:bandwidths:get”，“as:groups:get”，“astrocanvas:*:*”细粒度权限，若您之前通过AOM FullAccess策略对租户下子用户进行了权限控制，那么AOM FullAccess策略增加上述权限后，子用户也会展示上述云服务资源，您若仍有子用户云服务资源控制诉求，则您可自行进行自定义的子用户权限配置，从而达成子用户云服务资源展示控制效果。
-
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384
-
配置事件类告警策略 用户可以针对业务中的各类重要事件或对云资源的操作事件设置事件告警，在发生异常时及时通知您采取措施。事件类告警策略包括事件名称、触发时间周期、触发类型、触发次数和告警频率五个必要组成部分。您可以根据以下指引配置事件类告警策略。 基本概念 参数 参数说明 取值样例 事件名称 各服务监控事件的名称。 开机失败 触发时间周期 触发时间周期的含义是当该事件在5分钟内被累计触发时，向您发送告警信息。 触发时间周期可选择在5分钟内、在20分钟内、在1小时内、在4小时内、在24小时内。 说明： 当触发类型为累计触发时，该参数可选。 在5分钟内 触发类型 触发类型分为触发和累计触发。系统默认为触发。 触发表示当事件发生时，立即发送告警信息。 累计触发表示当事件在触发时间周期内累计触发预设的次数后，才能发生告警信息。 累计触发 触发次数 事件发生在触发时间周期内累计触发的次数。 说明： 当触发类型为累计触发时，该参数可选。 2 告警频率 当告警产生时，告警以特定的频率重复通知。 告警频率可设置以下几种方式： 只告警一次、每5分钟告警一次、每10分钟告警一次、每15分钟告警一次、每30分钟告警一次、每1小时告警一次、每3小时告警一次、每6小时告警一次、每12小时告警一次、每1天告警一次。 说明： 当触发类型为累计触发时，该参数可选。 每5分钟告警一次 配置事件类告警策略示例 例如，事件名称为开机失败 、触发时间周期为在5分钟内，触发类型为累计触发 、触发次数为2、告警频率为每5分钟告警一次。 表示：在5分钟内，某台云服务器开始失败事件累计触发2次则每5分钟触发告警一次。 图2 事件类告警策略
-
告警规则简介
云监控服务 支持灵活的创建告警规则。您既可以根据实际需要对某个特定的监控指标设置自定义告警规则，同时也支持使用告警模板为多个资源或者云服务批量创建告警规则。 在您使用告警模板创建告警规则之前，云监控服务已经根据各个云服务的应用属性以及云监控服务多年的开发、维护经验，为各个云服务量身定做了默认使用的告警模板，供您选择使用。同时云监控服务为用户提供了自定义创建告警模板的功能，用户可以选择在默认模板推荐的监控指标上进行修改，同样也支持自定义添加告警指标完成自定义告警模板的添加。 父主题： 告警规则
-
响应参数 状态码： 200 表5 响应Header参数 参数 参数类型 描述 X-request-id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表6 响应Body参数 参数 参数类型 描述 alert_count Integer 告警数量。Alert count. severity String 严重程度，提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.
-
请求示例 模拟一条告警规则，告警规则所属的管道ID为ead2769b-afb0-45dd-b9fa-a2953e6ac82f，查询类型为SQL，严重程度为提示。 { "pipe_id" : "ead2769b-afb0-45dd-b9fa-a2953e6ac82f", "query" : "* | select status, count(*) as count group by status", "query_type" : "SQL", "event_grouping" : true, "from" : 1665221214000, "to" : 1665546370000, "triggers" : [ { "mode" : "COUNT", "operator" : "GT", "expression" : 10, "severity" : "TIPS" } ]}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用
IAM 服务获取用户Token接口获取。 IAM user token, fetch from IAM api. 表3 请求Body参数 参数 是否必选 参数类型 描述 pipe_id 是 String 数据管道 ID。Pipe ID. query 是 String 查询语句。Query. query_type 否 String 查询语法，SQL。Query type. SQL. from 是 Long 开始时间。Start time. to 是 Long 结束时间。End time. event_grouping 否 Boolean 告警分组。Event grouping. triggers 是 Array of AlertRuleTrigger objects 告警触发规则。Alert triggers. 表4 AlertRuleTrigger 参数 是否必选 参数类型 描述 mode 否 String 模式，数量。Mode. COUNT. operator 否 String 操作符，等于、不等于、大于、小于。 operator. EQ equal, NE not equal, GT greater than, LT less than. expression 是 String expression severity 否 String 严重程度，提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL accumulated_times 否 Integer accumulated_times
-
注意事项 您最多可创建1000条阈值规则，如果阈值规则数量已达上限1000条时，请删除不需要的阈值规则后重新创建。 设置通知策略 阈值规则的状态（正常、超限阈值、数据不足）发生变化时，如需使用邮件或短信等方式发送通知，请参考下面操作在
SMN 界面设置通知策略。如不需接收邮件或短信通知，请跳过下面操作。具体操作如下： 创建一个主题，操作详见创建主题。 设置主题策略，操作详见设置主题策略。 设置主题策略时，“可发布消息的服务”必须选择“
APM ”，否则会导致通知发送失败。 为主题添加相关的订阅者，即通知的接收人（例如：邮件或短信），操作详见订阅主题。
-
更多静态阈值模板操作 静态阈值模板创建完成后，您还可以执行表1中的操作。 表1 相关操作 操作 说明 使用静态阈值模板创建一条批量阈值规则 单击“操作”列的“创建规则”，操作详见使用模板创建阈值规则。 修改静态阈值模板 单击“操作”列的“编辑”。 删除静态阈值模板 删除一个静态阈值模板：单击“操作”列的“删除”。 删除一个或多个静态阈值模板：选中一个或多个静态阈值模板前的复选框，单击页面上方的“删除”。 搜索静态阈值模板 在右上角的搜索框中输入模板名称关键字，单击后显示匹配对象。
