修改自定义告警模板 - UpdateAlarmTemplate
功能介绍
修改自定义告警模板
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
 - 如果使用身份策略授权,需具备如下身份策略权限。 
    
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ces:customAlarmTemplates:put
Write
-
g:EnterpriseProjectId
-
-
 
URI
PUT /v2/{project_id}/alarm-templates/{template_id}
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        是  | 
      
        String  | 
      
        项目ID  | 
     
| 
        template_id  | 
      
        是  | 
      
        String  | 
      
        告警模板ID  | 
     
请求参数
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        X-Auth-Token  | 
      
        是  | 
      
        String  | 
      
        租户Token  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        template_name  | 
      
        是  | 
      
        String  | 
      
        参数解释: 告警模板的名称。 约束限制: 不涉及。 取值范围: 以字母或汉字开头,可包含字母、数字、汉字、_、-,长度为[1,128]个字符。 默认取值: 不涉及。  | 
     
| 
        template_type  | 
      
        否  | 
      
        Integer  | 
      
        自定义告警模板类型 0:指标 2: 事件  | 
     
| 
        template_description  | 
      
        否  | 
      
        String  | 
      
        参数解释: 告警模板的描述 约束限制: 不涉及。 取值范围: 长度范围[0,256]。 默认取值: 空字符串。  | 
     
| 
        policies  | 
      
        是  | 
      
        Array of Policies objects  | 
      
        告警模板策略列表  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        namespace  | 
      
        是  | 
      
        String  | 
      
        参数解释: 查询服务的命名空间,各服务命名空间请参考“服务命名空间”。 约束限制: 不涉及。 取值范围: 格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 默认取值: 不涉及。  | 
     
| 
        dimension_name  | 
      
        否  | 
      
        String  | 
      
        参数解释: 资源维度。 约束限制: 事件告警模板DimensionName为空 取值范围: 必须以字母开头,多维度用","分隔,只能包含0-9/a-z/A-Z/_/-,每个维度的最大长度为32。目前最大支持4个维度。举例:单维度场景:instance_id;多维度场景:instance_id,disk 默认取值: 不涉及。  | 
     
| 
        metric_name  | 
      
        是  | 
      
        String  | 
      
        参数解释: 资源的监控指标名称,各服务的指标名称可查看:“服务指标名称”。 约束限制: 不涉及。 取值范围: 必须以字母开头,只能包含0-9/a-z/A-Z/_/-。字符长度最短为1,最大为96。如:弹性云服务器中的监控指标cpu_util,表示弹性服务器的CPU使用率;文档数据库中的指标mongo001_command_ps,表示command执行频率。 默认取值: 不涉及。  | 
     
| 
        extra_info  | 
      
        否  | 
      
        MetricExtraInfo object  | 
      
        参数解释: 告警策略附加信息。 约束限制: 不涉及。  | 
     
| 
        period  | 
      
        是  | 
      
        Integer  | 
      
        参数解释: 告警条件判断周期,单位为秒。 约束限制: 不涉及。 取值范围: 枚举值。 
 默认取值: 不涉及。  | 
     
| 
        filter  | 
      
        是  | 
      
        String  | 
      
        参数解释: 聚合方式。 约束限制: 不涉及。 取值范围: average: 平均值,variance:方差,min:最小值,max:最大值,sum:求和。 默认取值: 不涉及。  | 
     
| 
        comparison_operator  | 
      
        是  | 
      
        String  | 
      
        参数解释: 阈值符号。 约束限制: 指标告警可以使用的阈值符号有>、>=、<、<=、=、!=、cycle_decrease、cycle_increase、cycle_wave; 事件告警可以使用的阈值符号为>、>=、<、<=、=、!=。 取值范围: 支持的值为(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。 默认取值: 不涉及。  | 
     
| 
        value  | 
      
        否  | 
      
        Number  | 
      
        参数解释: 告警阈值。 约束限制: 单一阈值时value和alarm_level配对使用,当hierarchical_value和value同时使用时以hierarchical_value为准。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        hierarchical_value  | 
      
        否  | 
      
        HierarchicalValue object  | 
      
        参数解释: 多层级告警阈值。 约束限制: 当hierarchical_value和value同时使用时以hierarchical_value为准。 创建或修改告警规则以下2种场景只支持设置一个阈值: 1.告警类型为指标告警且告警策略为所有策略都满足才告警的场景。 2.告警类型为事件告警的场景。  | 
     
| 
        unit  | 
      
        否  | 
      
        String  | 
      
        参数解释: 数据的单位字符串,长度不超过32。 约束限制: 不涉及。 取值范围: 长度为[0,32]个字符 默认取值: 不涉及。  | 
     
| 
        selected_unit  | 
      
        否  | 
      
        String  | 
      
        参数解释: 用户在页面中选择的指标单位, 用于后续指标数据回显和计算。 约束限制: 不涉及。 取值范围: 长度为[0,64]个字符。 默认取值: 不涉及。  | 
     
| 
        count  | 
      
        是  | 
      
        Integer  | 
      
        参数解释: 告警连续触发次数。 约束限制: 不涉及。 取值范围: 事件告警时参数值为1~180(包括1和180);指标告警和站点告警时,次数采用枚举值,枚举值分别为:1、2、3、4、5、10、15、30、60、90、120、180。 默认取值: 不涉及。  | 
     
| 
        type  | 
      
        否  | 
      
        String  | 
      
        参数解释: 告警策略类型,已废弃,不推荐使用。 约束限制: 不涉及。 取值范围: 只能为auto。 默认取值: 不涉及。  | 
     
| 
        alarm_level  | 
      
        否  | 
      
        Integer  | 
      
        参数解释: 告警级别。 约束限制: 不涉及。 取值范围: 只能为1、2、3、4。 
 默认取值: 不涉及。  | 
     
| 
        suppress_duration  | 
      
        否  | 
      
        Integer  | 
      
        参数解释: 告警抑制周期,单位为秒。 约束限制: 不涉及。 取值范围: 枚举值,只能为0、300、600、900、1800、3600、10800、21600、43200、86400。 
 默认取值: 不涉及。  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        origin_metric_name  | 
      
        是  | 
      
        String  | 
      
        参数解释: 原始指标名称。 约束限制: 不涉及。 取值范围: 长度为[0,4096]个字符。 默认取值: 不涉及。  | 
     
| 
        metric_prefix  | 
      
        否  | 
      
        String  | 
      
        参数解释: 指标名称前缀。 约束限制: 不涉及。 取值范围: 长度为[0,4096]个字符。 默认取值: 不涉及。  | 
     
| 
        custom_proc_name  | 
      
        否  | 
      
        String  | 
      
        参数解释: 用户进程名称。 约束限制: 不涉及。 取值范围: 长度为[0,250]个字符。 默认取值: 不涉及。  | 
     
| 
        metric_type  | 
      
        否  | 
      
        String  | 
      
        参数解释: 指标类型。 约束限制: 不涉及。 取值范围: 长度为[0,32]个字符。 默认取值: 不涉及。  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        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] 默认取值: 不涉及。  | 
     
响应参数
状态码:204
No Content
状态码:400
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        请求异常内部业务状态码  | 
     
| 
        error_msg  | 
      
        String  | 
      
        请求异常信息  | 
     
| 
        request_id  | 
      
        String  | 
      
        请求ID  | 
     
状态码:401
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        请求异常内部业务状态码  | 
     
| 
        error_msg  | 
      
        String  | 
      
        请求异常信息  | 
     
| 
        request_id  | 
      
        String  | 
      
        请求ID  | 
     
状态码:403
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        请求异常内部业务状态码  | 
     
| 
        error_msg  | 
      
        String  | 
      
        请求异常信息  | 
     
| 
        request_id  | 
      
        String  | 
      
        请求ID  | 
     
状态码:404
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        请求异常内部业务状态码  | 
     
| 
        error_msg  | 
      
        String  | 
      
        请求异常信息  | 
     
| 
        request_id  | 
      
        String  | 
      
        请求ID  | 
     
状态码:500
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        请求异常内部业务状态码  | 
     
| 
        error_msg  | 
      
        String  | 
      
        请求异常信息  | 
     
| 
        request_id  | 
      
        String  | 
      
        请求ID  | 
     
请求示例
修改模板名称为my_template的自定义告警模板,修改其指标周期、聚合方式、阀值、单位、次数、告警抑制时间和告警级别等参数。
{
  "template_name" : "my_template",
  "template_description" : "hello world",
  "policies" : [ {
    "namespace" : "SYS.ECS",
    "dimension_name" : "instance_id",
    "metric_name" : "cpu_util",
    "period" : 300,
    "filter" : "sum",
    "comparison_operator" : ">",
    "value" : 2,
    "unit" : "bit/s",
    "count" : 2,
    "alarm_level" : 2,
    "suppress_duration" : 300
  } ]
}
 响应示例
无
状态码
| 
        状态码  | 
      
        描述  | 
     
|---|---|
| 
        204  | 
      
        No Content  | 
     
| 
        400  | 
      
        参数校验失败  | 
     
| 
        401  | 
      
        未认证  | 
     
| 
        403  | 
      
        认证鉴权失败  | 
     
| 
        404  | 
      
        资源不存在  | 
     
| 
        500  | 
      
        系统内部错误  | 
     
错误码
请参见错误码。