# 查询自定义告警模板列表 - ListAlarmTemplates #### 功能介绍 查询自定义告警模板列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=ListAlarmTemplates&version=v1)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:customAlarmTemplates:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /V1.0/{project_id}/alarm-template 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,64\]个字符。 **默认取值**: 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | alarmTemplateId | 否 | String | **参数解释**： 自定义告警模板的ID，如：at1603330892378wkDm77y6B **约束限制**： 不涉及 **取值范围**： 以at开头，后跟字母、数字，长度最长为64 **默认取值**： 不涉及 | | namespace | 否 | String | **参数解释**： 自定义告警模板选择的资源类型。即命名空间，如弹性云服务器的资源命名空间为：SYS.ECS；各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **约束限制**： 不涉及 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 **默认取值**： 不涉及 | | dname | 否 | String | **参数解释**： 自定义告警模板选择的资源维度，如：弹性云服务器，则维度为instance_id，各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **约束限制**： 不涉及 **取值范围**： 包含0-9/a-z/A-Z/_。字符串的长度必须在 1 到 131个字符之间。 **默认取值**： 不涉及 | | start | 否 | String | **参数解释**： 分页起始位置，值为告警模板的ID，如：at1603330892378wkDm77y6B。 **约束限制**： 不涉及 **取值范围**： 以at开头，后跟字母、数字，长度最长为64 **默认取值**： 不涉及 | | limit | 否 | String | **参数解释**： 单次查询的条数限制，取值范围(0,100\]，默认值为100， 用于限制结果数据条数。 **约束限制**： 不涉及 **取值范围**： 整数，最小值为1，最大值为100。 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,64\]个字符。 **默认取值**: 默认使用 application/json; charset=UTF-8，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,16384\]个字符。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_templates | Array of [AlarmTemplate] objects | 自定义告警模板详细信息。 | | meta_data | [MetaData] object | **参数解释**： 查询结果元数据信息，包括分页信息等 | 表5AlarmTemplate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | template_name | String | **参数解释**： 自定义告警模板名称 **取值范围**： 以字母或汉字开头，可包含字母、数字、汉字、_、-，长度为\[1,256\]个字符，如：alarmTemplate-Test01。 | | template_description | String | **参数解释**： 自定义告警模板描述。 **取值范围**： 长度范围\[0,256\]。 | | namespace | String | **参数解释** 创建自定义告警模板选择的资源类型，即服务命名空间，如：选择弹性云服务器，则命名空间为SYS.ECS；各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 | | dimension_name | String | **参数解释** 资源类型对应的指标监控维度，选择弹性云服务器，则维度为云服务器，dimension_name值为instance_id；各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 必须以字母开头，多维度用","分隔，只能包含0-9/a-z/A-Z/_/-，每个维度的最大长度为32。目前最大支持4个维度。字符串总最大长度为131。举例：单维度场景：instance_id；多维度场景：instance_id,disk | | template_items | Array of [TemplateItem] objects | 自定义告警模板添加的一组或者多个告警策略。 | | template_id | String | **参数解释** 自定义告警模板的ID，如：at1603330892378wkDm77y6B **取值范围**： 以at开头，后跟字母、数字，长度最长为64 | 表6TemplateItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric_name | String | **参数解释** 告警模板添加的监控指标，如弹性云服务器可添加的监控指标为cpu_util等；各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 字符串长度在 1 到 64 之间。 | | condition | [AlarmTemplateCondition] object | 创建自定义告警模板的告警策略。 | | alarm_level | Integer | **参数解释**： 告警级别。 **取值范围**： 只能为1、2、3、4。 - 1为紧急 - 2为重要 - 3为次要 - 4为提示 | 表7AlarmTemplateCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | comparison_operator | String | **参数解释**： 阈值符号。 **取值范围**： - \> 大于 - \< 小于 - \>= 大于等于 - \<= 小于等于 - = 等于 - != 不等于 - cycle_decrease 环比下降 - cycle_increase 环比上升 - cycle_wave 环比波动 | | count | Integer | **参数解释**： 触发告警的连续发生次数。 **取值范围**： 整数，取值范围\[1, 5\]。 | | filter | String | **参数解释**： 数据聚合的方式。 **取值范围**： - average：平均值 - variance：方差 - min：最小值 - max：最大值 - sum：求和 | | 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天聚合周期为一个数据点参与告警计算。 | | unit | String | **参数解释**： 数据的单位。 **取值范围**： 长度为\[0,32\]个字符。 | | value | Number | **参数解释**： 告警阈值。具体阈值取值范围请参见附录中各服务监控指标中取值范围，您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 最小值为-1.7976931348623157e+108，最大值为1.7976931348623157e+108。 | | suppress_duration | Integer | **参数解释**： 告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题。 **取值范围**： 枚举值 - 0：对于指标类告警，0代表告警一次。对于事件类告警，在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。 - 300：代表满足告警触发条件后每5分钟告警一次。 - 600：代表满足告警触发条件后每10分钟告警一次。 - 900：代表满足告警触发条件后每15分钟告警一次。 - 1800：代表满足告警触发条件后每30分钟告警一次。 - 3600：代表满足告警触发条件后每60分钟告警一次。 - 10800：代表满足告警触发条件后每3小时告警一次。 - 21600：代表满足告警触发条件后每6小时告警一次。 - 43200：代表满足告警触发条件后每12小时告警一次。 - 86400：代表满足告警触发条件后每一天告警一次。 | 表8MetaData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**： 当前返回结果条数。 **取值范围**： 在\[0,2147483647\]区间内 | | total | Integer | **参数解释**： 总条数。 **取值范围**： 在\[0,2147483647\]区间内 | | marker | String | **参数解释**： 下一个开始的标记（告警模板ID），用于分页。当前响应体中的marker作为下一个请求的start参数。 **取值范围**： 以at开头，后跟字母、数字，长度最长为64。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求错误。 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 未提供认证信息，或认证信息错误。 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求页面被禁止访问。 | **状态码：408** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求超出了服务器的等待时间。 | **状态码：429** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求过多。 | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求未完成，服务异常。 | **状态码：503** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 系统暂时不可用，请求受限。 | #### 请求示例 ``` /V1.0/{project_id}/alarm-template ``` #### 响应示例 **状态码：200** OK ``` { "alarm_templates" : [ { "template_name" : "alarmTemplate-Test01", "template_description" : "创建自定义告警模板", "namespace" : "SYS.ECS", "dimension_name" : "instance_id", "template_items" : [ { "metric_name" : "cpu_util", "condition" : { "period" : 1, "filter" : "average", "comparison_operator" : ">=", "value" : 90, "unit" : "%", "count" : 3, "suppress_duration" : 300 }, "alarm_level" : 2 }, { "metric_name" : "mem_util", "condition" : { "period" : 1, "filter" : "average", "comparison_operator" : ">=", "value" : 90, "unit" : "%", "count" : 3, "suppress_duration" : 600 }, "alarm_level" : 2 } ], "template_id" : "at1604474818207Jo7o7R4Nj" } ], "meta_data" : { "count" : 1, "marker" : "at1603330892378wkDm77y6B", "total" : 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 408 | Request Timeout | | 429 | Too Many Requests | | 500 | Internal Server Error | | 503 | Service Unavailable | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。