# 查询告警规则列表（推荐） - ListAlarmRules #### 功能介绍 查询告警规则列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=ListAlarmRules&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:alarms:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/alarms 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 字符串的长度必须在 1 到 64个字符之间。 **默认取值**: 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | alarm_id | 否 | String | **参数解释**： 告警规则ID。 **约束限制**： 不涉及。 **取值范围**： 以al开头，后跟22位的字母或数字。 **默认取值**： 不涉及。 | | name | 否 | String | **参数解释**： 告警规则名称。 **约束限制**： 不涉及。 **取值范围**： 只能包含0-9/a-z/A-Z/_/-或汉字，长度为\[1,128\]个字符。 **默认取值**： 不涉及。 | | namespace | 否 | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **约束限制**： 不涉及。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度在 0 到 32个字符之间。 **默认取值**： 不涉及。 | | resource_id | 否 | String | **参数解释**： 告警资源ID。 **约束限制**： 不涉及。 **取值范围**： 多维度情况按字母升序排列并使用逗号分隔。 长度为\[0,700\]个字符。 **默认取值**： 不涉及。 | | enterprise_project_id | 否 | String | **参数解释**： 企业项目ID。 **约束限制**： 不涉及。 **取值范围**： 只能包含小写字母、数字、"-"、"_"，可以自定义企业项目ID，长度为36个字符。也可以为0（代表默认企业项目ID），all_granted_eps（代表所有企业项目ID）。 **默认取值**： 不涉及。 | | product_name | 否 | String | **参数解释**： 资源所属的云产品名称，一般由"服务命名空间,服务首层维度名称"组成，如"SYS.ECS,instance_id"。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,128\]个字符。 **默认取值**： 不涉及。 | | resource_level | 否 | String | **参数解释**： 创建告警规则，需要指定的资源层级。resource_level取值为product即为云产品类型，不填或者取值为dimension则为子维度类型。 **约束限制**： 不涉及。 **取值范围**： 枚举值。 - product：云产品。 - dimension：子维度。 **默认取值**： 不涉及。 | | offset | 否 | Integer | **参数解释**： 分页偏移量。 **约束限制**： 不涉及。 **取值范围**： \[0,10000\] **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 分页大小。 **约束限制**： 不涉及。 **取值范围**： \[1,100\] **默认取值**： 10 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为64。 **默认取值**: 默认使用application/json; charset=UTF-8。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。Token认证，具体操作请参考[认证鉴权](https://support.huaweicloud.com/api-ces/ces_03_0011.html)。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为16384。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarms | Array of [alarms] objects | **参数解释**： 告警规则列表。 | | count | Integer | **参数解释**： 告警规则总数。 **取值范围**： \[0,10000\] | 表5alarms | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_id | String | **参数解释**： 告警规则id。如 al16558829757444BVVxr999 **取值范围**： 以al开头，后跟22个数字或字母。长度为24个字符。 | | name | String | **参数解释**： 告警规则名称。 **取值范围**： 只能包含0-9/a-z/A-Z/_/-或汉字，长度\[1，128\]个字符。 | | description | String | **参数解释**： 告警描述。 **取值范围**： 长度为\[0,256\]个字符。 | | namespace | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度为\[0,32\]个字符。 | | policies | Array of [PolicyResp] objects | **参数解释**： 告警策略 | | resources | Array of [ResourcesInListResp] objects | **参数解释**： 资源列表，关联资源需要使用[查询告警规则资源列表](https://support.huaweicloud.com/api-ces/ListAlarmRuleResources.html)获取。 | | type | String | **参数解释**： 告警规则类型 **取值范围**： 枚举值。 - ALL_INSTANCE：针对全部资源的告警规则。 - RESOURCE_GROUP：针对资源分组的告警规则。 - MULTI_INSTANCE：针对指定资源的告警规则。 - EVENT.SYS：系统事件告警规则。 - EVENT.CUSTOM：自定义事件告警规则。 - DNSHealthCheck：健康检查告警规则。 | | enabled | Boolean | **参数解释**： 是否开启告警规则。 **取值范围**： 布尔值。 - true:开启。 - false:关闭。 | | notification_enabled | Boolean | **参数解释**： 是否开启告警通知。 **取值范围**： 布尔值。 - true:开启。 - false:关闭。 | | alarm_notifications | Array of [NotificationResp] objects | **参数解释**： 触发告警时，通知组/主题订阅的信息。 | | ok_notifications | Array of [NotificationResp] objects | **参数解释**： 告警恢复时，通知组/主题订阅的信息。 | | notification_begin_time | String | **参数解释**： 告警通知开启时间。如 00:00 **取值范围**： 只能包含数字、":"，长度为\[1,64\]个字符。 | | notification_end_time | String | **参数解释**： 告警通知关闭时间。如 08:00 **取值范围**： 只能包含数字、":"，长度为\[1,64\]个字符。 | | effective_timezone | String | **参数解释**： 时区，形如："GMT-08:00"、"GMT+08:00"、"GMT+0:00"。 **取值范围**： 长度为\[1,16\]个字符。 | | enterprise_project_id | String | **参数解释**： 企业项目ID。 **取值范围**： 只能包含小写字母、数字、"-"。0 代表默认企业项目ID | | alarm_template_id | String | **参数解释**： 告警规则关联告警模板ID **取值范围**： 以at开头，只包含字母、数字，长度为\[2,64\]个字符。 | | product_name | String | **参数解释**： 当资源层级为云产品时的云产品名称，一般由"服务命名空间,服务首层维度名称"组成，如"SYS.ECS,instance_id"。 **取值范围**: 长度为\[0,128\]个字符。 | | resource_level | String | **参数解释**： 资源层级。 **取值范围**: 枚举值。 - product：云产品。 - dimension：子维度。 | | tags | Array of [ResourceTagResp] objects | **参数解释**： 租户标签列表 **取值范围**: 最多支持20个标签。 | 表6PolicyResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric_name | String | **参数解释**： 资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。 | | period | Integer | **参数解释**： 指标周期，单位是秒。如想了解各个云服务的指标原始周期可以参考[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 - 0代表立即触发，仅限事件场景使用。 - 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算。 - 300代表指标按5分钟聚合周期为一个数据点参与告警计算。 - 1200代表指标按20分钟聚合周期为一个数据点参与告警计算。 - 3600代表指标按1小时聚合周期为一个数据点参与告警计算。 - 14400代表指标按4小时聚合周期为一个数据点参与告警计算。 - 86400代表指标按1天聚合周期为一个数据点参与告警计算。 **取值范围**： 枚举值。 | | filter | String | **参数解释**： 聚合方式。 **取值范围**： - average：平均值 - variance：方差 - min：最小值 - max：最大值 - sum：求和 | | comparison_operator | String | **参数解释**： 阈值符号。 **取值范围**： 支持的值为(\>\|\<\|\>=\|\<=\|=\|!=\|cycle_decrease\|cycle_increase\|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。 | | value | Number | **参数解释**： 告警阈值。具体阈值取值请参见[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 最小值为-1.7976931348623157e+108，最大值为1.7976931348623157e+108。 | | hierarchical_value | [HierarchicalValueResp] object | **参数解释**： 多层级告警阈值。 | | unit | String | **参数解释**： 数据的单位。 **取值范围**： 长度为\[0,32\]个字符。 | | count | Integer | **参数解释**： 告警连续触发次数。 **取值范围**： 事件告警时参数值为1\~180（包括1和180）；指标告警和站点告警时，次数采用枚举值，枚举值分别为：1、2、3、4、5、10、15、30、60、90、120、180。 | | suppress_duration | Integer | **参数解释**： 告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题。 **取值范围**： 枚举值，只能为0、300、600、900、1800、3600、10800、21600、43200、86400。 - 0：对于指标类告警，0代表告警一次，对于事件类告警，在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。 - 300代表满足告警触发条件后每5分钟告警一次。 - 600代表满足告警触发条件后每10分钟告警一次。 - 900代表满足告警触发条件后每15分钟告警一次。 - 1800代表满足告警触发条件后每30分钟告警一次。 - 3600代表满足告警触发条件后每60分钟告警一次。 - 10800代表满足告警触发条件后每3小时告警一次。 - 21600代表满足告警触发条件后每6小时告警一次。 - 43200代表满足告警触发条件后每12小时告警一次。 - 86400代表满足告警触发条件后每一天告警一次。 | | level | Integer | **参数解释**： 告警级别。 **取值范围**： 只能为1、2、3、4。 - 1：紧急 - 2：重要 - 3：次要 - 4：提示 | | namespace | String | **参数解释**： 产品层级规则增加namespace（服务命名空间）和dimension_name（服务维度名称，用于指明生效策略的资源归属。各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在0到32个字符之间。 | | dimension_name | String | **参数解释**： 资源维度名称，各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。云产品层级的告警规则需要增加namespace和dimension_name，用于指明策略生效的资源归属。 **取值范围**： 目前最大支持4个维度。举例：单维度场景：instance_id；多维度场景：instance_id,disk | 表7HierarchicalValueResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | critical | Double | **参数解释**： 紧急级别的阈值。 **取值范围**： \[-1.7976931348623157e+108, 1.7976931348623157e+108\] | | major | Double | **参数解释**： 重要级别的阈值。 **取值范围**： \[-1.7976931348623157e+108, 1.7976931348623157e+108\] | | minor | Double | **参数解释**： 次要级别的阈值。 **取值范围**： \[-1.7976931348623157e+108, 1.7976931348623157e+108\] | | info | Double | **参数解释**： 提示级别的阈值。 **取值范围**： \[-1.7976931348623157e+108, 1.7976931348623157e+108\] | 表8ResourcesInListResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_group_id | String | **参数解释**： 资源分组ID，监控范围为资源分组时，存在该值。 **取值范围**： 以rg开头，后跟22个字母或数字。 | | resource_group_name | String | **参数解释**： 资源分组名称，监控范围为资源分组时，存在该值。 **取值范围**： 长度为\[1,128\]个字符。 | | dimensions | Array of [MetricDimensionResp] objects | **参数解释**： 维度信息。 | 表9MetricDimensionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 资源维度名称。 **取值范围**： 以字母开头，长度为\[1,32\]个字符。 | | value | String | **参数解释**： 资源维度值。 **取值范围**： 长度为\[0,256\]个字符。 | 表10NotificationResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 通知类型。 **取值范围**： 枚举值。 - notification：通知组或主题订阅。 - contact：云账号联系人。 - contactGroup：（已废弃）通知组。 - autoscaling：AS通知，只在AS中使用，不推荐客户使用。 - groupwatch：已废弃，不推荐使用。 - ecsRecovery：已废弃，不推荐使用。 - iecAction：已废弃，不推荐使用。 | | notification_list | Array of strings | **参数解释**： 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。 | 表11ResourceTagResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签名。 **取值范围**： 长度\[1,128\]个unicode字符。 | | value | String | **参数解释**： 标签值。 **取值范围**： 长度为\[0,255\]个unicode字符。 | **状态码：400** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | #### 请求示例 查询告警规则列表 ``` /v2/{project_id}/alarms?offset=0&limit=10 ``` #### 响应示例 **状态码：200** 查询成功 ``` { "alarms" : [ { "alarm_id" : "al16558829757444BVVxr999", "name" : "alarm01", "description" : "", "namespace" : "SYS.ECS", "policies" : [ { "metric_name" : "disk_device_read_bytes_rate", "period" : 1, "filter" : "average", "comparison_operator" : ">", "value" : 75, "unit" : "byte/s", "count" : 3, "suppress_duration" : 10800, "level" : 2 } ], "resources" : [ { "dimensions" : [ { "name" : "disk_name" } ] } ], "type" : "ALL_INSTANCE", "enabled" : true, "notification_enabled" : true, "alarm_notifications" : [ { "type" : "notification", "notification_list" : [ "urn:smn:xxx:xxx70e7359:topic_xxx" ] } ], "ok_notifications" : [ { "type" : "notification", "notification_list" : [ "urn:smn:xxx:xxx70e7359:topic_xxx" ] } ], "notification_begin_time" : "00:00", "notification_end_time" : "23:59", "enterprise_project_id" : "0", "tags" : [ { "key" : "Usage", "value" : "project1" } ] } ], "count" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | | 400 | 参数校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。