华为云用户手册

请求参数 表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

URI GET /v2/{project_id}/alarms/{alarm_id}/policies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 alarm_id 是 String 告警规则ID 正则匹配：^al([0-9A-Za-z]){22}$ 表2 Query参数 参数 是否必选 参数类型 描述 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)$

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 one_click_alarms Array of one_click_alarms objects 一键告警列表 数组长度：1 - 1000 表4 one_click_alarms 参数 参数类型 描述 one_click_alarm_id String 一键告警ID namespace String 指标命名空间 description String 一键告警描述，长度范围[0,256]，该字段默认值为空字符串 enabled Boolean 开关 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token。 最小长度：1 最大长度：16384

URI GET /v2/{project_id}/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID。 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ resource_type 是 String 资源类型。 CES -alarm：告警规则，CES-dashboard：dashboard，CES-resourceGroup：资源分组，CES-qualityMonitor：质量监控 最小长度：1 最大长度：32 枚举值： CES-alarm CES-dashboard CES-resourceGroup CES-qualityMonitor

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 租户标签列表 数组长度：0 - 20 表4 Tag 参数 参数类型 描述 key String 键；最大长度128个unicode字符。 key不能为空。 最小长度：0 最大长度：128 values Array of strings 值列表； 每个值最大长度255个unicode字符。如果values为空列表，则表示查询任意value 最小长度：0 最大长度：255 数组长度：0 - 20 状态码： 404 表5 响应Body参数 参数 参数类型 描述 http_code Integer Http状态码。200:：OK，404：资源不存在。 最小值：3 最大值：3 枚举值： 200 404 message GoAPIErrorResponseMsg object 错误信息 表6 GoAPIErrorResponseMsg 参数 参数类型 描述 details String 错误信息 最小长度：0 最大长度：1024 code String 业务错误码 最小长度：1 最大长度：16

请求参数 表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

URI GET /v2/{project_id}/alarm-histories 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ 表2 Query参数 参数 是否必选 参数类型 描述 alarm_id 否 String 告警ID,以al开头，后跟22位由字母或数字组成的字符串 最小长度：24 最大长度：24 record_id 否 String 告警记录ID,以ah开头，后跟22位由字母或数字组成的字符串 最小长度：24 最大长度：24 name 否 String 告警规则名称 最小长度：0 最大长度：128 status 否 String 告警规则状态, ok为正常，alarm为告警，invalid为已失效 最小长度：0 最大长度：64 正则匹配：^(ok|alarm|invalid)$ level 否 Integer 告警级别, 1为紧急，2为重要，3为次要，4为提示 最小值：1 最大值：4 namespace 否 String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” 最小长度：3 最大长度：32 resource_id 否 String 告警资源ID，多维度情况按字母升序排列并使用逗号分隔 最小长度：0 最大长度：2048 from 否 String 查询告警记录的起始时间，例如：2022-02-10T10:05:46+08:00 最小长度：0 最大长度：64 to 否 String 查询告警记录的截止时间，例如：2022-02-10T10:05:47+08:00 最小长度：0 最大长度：64 offset 否 Integer 分页偏移量 最小值：0 最大值：999 缺省值：0 正则匹配：^(0|[1-9]|[1-9][0-9])$ limit 否 Integer 分页大小 最小值：1 最大值：100 缺省值：100 正则匹配：^([1-9]|[1-9][0-9]|100)$

响应示例 状态码： 200 OK { "dashboards" : [ { "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx", "ret_status" : "successful" }, { "dashboard_id" : "dbXXXXXXXXXXXXXXXXXXXXXX", "ret_status" : "error", "error_msg" : "record not found" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：16000 表3 请求Body参数 参数 是否必选 参数类型 描述 dashboard_ids 否 Array of strings 监控看板id列表 数组长度：1 - 30

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 dashboards Array of BatchDeleteDashboardRespInfo objects 批量删除监控看板返回结果 数组长度：1 - 100 表5 BatchDeleteDashboardRespInfo 参数 参数类型 描述 dashboard_id String 监控看板id 正则匹配：^db([a-z]|[A-Z]|[0-9]){22} ret_status String 处理结果, successful: 成功, error: 失败 枚举值： successful error error_msg String 错误信息 最小长度：0 最大长度：128 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

请求参数 表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

URI GET /v2/{project_id}/alarms/{alarm_id}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 alarm_id 是 String Alarm实例ID 正则匹配：al([a-z]|[A-Z]|[0-9]){22}$ 表2 Query参数 参数 是否必选 参数类型 描述 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 OK { "alarm_templates" : [ { "template_id" : "at1628592157541dB1klWgY6", "template_name" : "my_template", "template_type" : "custom", "create_time" : "2006-01-02T15:04:05.000Z", "template_description" : "hello world" } ], "count" : 100 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 alarm_templates Array of AlarmTemplates objects 告警模板列表 数组长度：0 - 100 count Integer 告警模板记录总数 最小值：0 最大值：9999999 表5 AlarmTemplates 参数 参数类型 描述 template_id String 告警模板的ID，以at开头，后跟字母、数字，长度最长为64 template_name String 告警模板的名称，以字母或汉字开头，可包含字母、数字、汉字、_、-，长度范围[1,128] template_type String 模板类型(custom代表默认自定义模板，system代表系统模板) 枚举值： system custom create_time String 告警模板的创建时间 template_description String 告警模板的描述，长度范围[0,256]，该字段默认值为空字符串 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

URI GET /v2/{project_id}/alarm-templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询时查询的起始位置，表示从第几条数据开始，默认为0 最小值：0 最大值：10000 limit 否 Integer 查询结果条数的限制值，取值范围为[1,100]，默认值为100 最小值：1 最大值：100 namespace 否 String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” 最小长度：3 最大长度：32 正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ dim_name 否 String 资源维度，必须以字母开头，多维度用","分割，只能包含0-9/a-z/A-Z/_/-，每个维度的最大长度为32 最小长度：1 最大长度：131 正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$ template_type 否 String 模板类型(system代表默认指标模板，custom代表自定义指标模板，system_event代表默认事件模板，custom_event代表自定义事件模板，system_custom_event代表全部事件模板),不传返回全部指标模板 枚举值： system custom system_event custom_event system_custom_event template_name 否 String 告警模板的名称，以字母或汉字开头，可包含字母、数字、汉字、_、-，长度范围[1,128]，支持模糊匹配 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s)+$

响应示例 状态码： 200 OK { "alarms" : [ { "alarm_id" : "al123232232341232132", "name" : "alarm1", "description" : "hello world", "namespace" : "SYS.E CS ", "policies" : [ { "alarm_policy_id" : "alxdxxxdsw12321321", "metric_name" : "cpu_util", "period" : 0, "filter" : "max", "comparison_operator" : "", "value" : 1.7976931348623156E108, "unit" : "%", "count" : 100, "suppress_duration" : 0, "level" : 2, "enabled" : true } ], "resources" : [ { "dimensions" : [ { "name" : "string", "value" : "string" } ] } ], "type" : "EVENT.SYS", "enabled" : true, "notification_enabled" : true, "alarm_notifications" : [ { "type" : "notification", "notification_list" : [ "urn:smn:123" ] } ], "ok_notifications" : [ { "type" : "notification", "notification_list" : [ "urn:smn:123" ] } ], "notification_begin_time" : "00:00", "notification_end_time" : "23:59" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384

URI GET /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ one_click_alarm_id 是 String 一键告警ID 最小长度：1 最大长度：64

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 alarms Array of alarms objects 告警规则列表 数组长度：1 - 100 表4 alarms 参数 参数类型 描述 alarm_id String 告警规则ID，以al开头，包含22个数字或字母 name String 告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字，长度1-128 description String 告警描述，长度0-256 namespace String 指标命名空间 policies Array of Policy objects 告警策略 数组长度：1 - 100 resources Array of ResourcesInListResp objects 资源列表，关联资源需要使用查询告警规则资源接口获取 数组长度：1 - 3000 type String 告警规则类型 enabled Boolean 告警开关 notification_enabled Boolean 是否开启告警通知 alarm_notifications Array of SMN Action objects 告警触发的动作 ok_notifications Array of SMNAction objects 告警恢复触发的动作 notification_begin_time String 告警通知开启时间 notification_end_time String 告警通知关闭时间 表5 Policy 参数 参数类型 描述 alarm_policy_id String 告警规则策略ID metric_name String 指标名称 period Integer 告警条件判断周期，单位秒，1表示以原始数据判断告警，当告警的alarm_type为(EVENT.SYS|EVENT.CUSTOM)时可能为0 枚举值： 0 1 300 1200 3600 14400 86400 filter String 聚合方式 comparison_operator String 告警阈值的比较条件 value Number 阈值 unit String 单位 count Integer 次数 suppress_duration Integer 抑制周期，单位秒，0表示只告警一次 枚举值： 0 300 600 900 1800 3600 10800 21600 43200 86400 level Integer 告警级别, 1为紧急，2为重要，3为次要，4为提示 enabled Boolean 开关 表6 ResourcesInListResp 参数 参数类型 描述 resource_group_id String 资源分组ID，监控范围为资源分组时存在该值 正则匹配：^rg([a-z]|[A-Z]|[0-9]){22}$ resource_group_name String 资源分组名称，监控范围为资源分组时存在该值 最小长度：1 最大长度：128 dimensions Array of MetricDimension objects 维度信息 数组长度：0 - 10000 表7 MetricDimension 参数 参数类型 描述 name String 指标维度名称 最小长度：1 最大长度：32 正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ value String 指标维度值 最小长度：0 最大长度：256 正则匹配：^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-)*)|){0,256}$ 表8 SMNAction 参数 参数类型 描述 type String 通知类型,枚举类型：notification,autoscaling,groupwatch,ecsRecovery,contact,contactGroup,iecAction 枚举值： notification autoscaling groupwatch ecsRecovery contact contactGroup iecAction 正则匹配：^(notification|autoscaling|groupwatch|ecsRecovery|contact|contactGroup|iecAction)$ notification_list Array of strings 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notificationList列表不能为空；当type为autoscaling时，列表必须为[]。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notificationList值保持一致。 数组长度：0 - 20 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

响应示例 状态码： 200 OK { "count" : 1000, "resources" : [ { "status" : "health", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 资源总数 最小值：0 最大值：10000 resources Array of GetResourceGroupResources objects 资源分组资源列表 数组长度：0 - 100 表5 GetResourceGroupResources 参数 参数类型 描述 status String 资源健康状态，取值为health（已设置告警规则且无告警触发的资源）、unhealthy（已设置告警规则且有告警触发的资源）、no_alarm_rule（未关联告警规则） 枚举值： health unhealthy no_alarm_rule dimensions Array of Dimension objects 资源的维度信息 数组长度：1 - 4 表6 Dimension 参数 参数类型 描述 name String 资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务指标维度”。 正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ value String 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。 正则匹配：^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

URI GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 group_id 是 String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 service 是 String 服务类别，如SYS.ECS 最小长度：3 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 否 String 资源维度信息，多个维度按字母序使用逗号分割 最小长度：1 最大长度：131 limit 否 String 分页查询时每页的条目数，取值[1,100]，默认值为100 最小长度：1 最大长度：100 offset 否 Integer 分页查询时查询的起始位置，表示从第几条数据开始，默认为0 最小值：0 最大值：10000 status 否 String 按状态信息进行过滤，取值只能为health（已设置告警规则且无告警触发的资源）、unhealthy（已设置告警规则且有告警触发的资源）、no_alarm_rule（未设置告警规则的资源） 枚举值： health unhealthy no_alarm_rule dim_value 否 String 资源维度值，不支持模糊匹配，但是多维度资源可以只指定一个维度值 最小长度：1 最大长度：1027 tag 否 String 资源的标签信息，格式："[key]":"[value]"，样例参考："ssss":"1111" 最小长度：0 最大长度：500 extend_relation_id 否 String 企业项目ID 最小长度：0 最大长度：128

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

请求示例 { "notification_enabled" : true, "alarm_notifications" : [ { "type" : "notification", "notification_list" : [ "urn:smn:123" ] } ], "ok_notifications" : [ { "type" : "notification", "notification_list" : [ "urn:smn:123" ] } ], "notification_begin_time" : "00:00", "notification_end_time" : "23:59" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 notification_enabled 是 Boolean 是否开启告警通知 alarm_notifications 否 Array of SMNAction objects 告警触发的动作 ok_notifications 否 Array of SMNAction objects 告警恢复触发的动作 notification_begin_time 否 String 告警通知开启时间 notification_end_time 否 String 告警通知关闭时间 表4 SMNAction 参数 是否必选 参数类型 描述 type 是 String 通知类型,枚举类型：notification,autoscaling,groupwatch,ecsRecovery,contact,contactGroup,iecAction 枚举值： notification autoscaling groupwatch ecsRecovery contact contactGroup iecAction 正则匹配：^(notification|autoscaling|groupwatch|ecsRecovery|contact|contactGroup|iecAction)$ notification_list 是 Array of strings 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notificationList列表不能为空；当type为autoscaling时，列表必须为[]。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notificationList值保持一致。 数组长度：0 - 20

URI PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/notifications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ one_click_alarm_id 是 String 一键告警ID 最小长度：1 最大长度：64

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 资源分组名称，只能为字母、数字、汉字、-、_，最大长度为128 最小长度：1 最大长度：128 tags 否 Array of ResourceGroupTagRelation objects 标签动态匹配时的关联标签,type为TAG时该字段不为空 数组长度：1 - 10 表4 ResourceGroupTagRelation 参数 是否必选 参数类型 描述 key 是 String 键 最小长度：1 最大长度：36 value 否 String 值 最小长度：1 最大长度：42