华为云用户手册

响应参数 状态码： 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

请求参数 表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 表4 请求Body参数 参数 是否必选 参数类型 描述 relation_type 是 String 关联类型。ALARM_RULE：关联告警规则，RESOURCE：关联资源，RESOURCE_POLICY_NOTIFICATION：关联资源策略屏蔽告警通知，RESOURCE_POLICY_ALARM：关联资源策略不计算告警，DEFAULT：默认包含RESOURCE、RESOURCE_POLICY_NOTIFICATION（查询告警屏蔽列表时使用）。 枚举值： ALARM_RULE RESOURCE RESOURCE_POLICY_NOTIFICATION RESOURCE_POLICY_ALARM DEFAULT relation_ids 是 Array of strings 关联编号（目前是告警规则ID） 数组长度：1 - 100 mask_id 否 String 屏蔽规则ID,可选 最小长度：1 最大长度：64 正则匹配：^nm([0-9A-Za-z]){0,62}$ mask_name 否 String 屏蔽规则名称,可选，只能为字母、数字、汉字、-、_，最大长度为64 最小长度：1 最大长度：64 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ mask_status 否 String 屏蔽状态,可选。MASK_EFFECTIVE：已生效，MASK_INEFFECTIVE：未生效。 最小长度：1 最大长度：32 枚举值： MASK_EFFECTIVE MASK_INEFFECTIVE resource_id 否 String 资源维度值,提供一个维度的资源ID即可,可选 最小长度：1 最大长度：700 namespace 否 String 资源命名空间，例如弹性云服务器命名空间(格式为service.item；service和item必须是字符串，以字母开头，可包含0-9/a-z/A-Z/_；长度范围[3,32]。) dimensions 否 Array of Dimension objects 资源的维度信息 数组长度：1 - 4 表5 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}$

请求示例 { "relation_type" : "DEFAULT", "relation_ids" : [ "al123232232341232132" ], "mask_id" : "nm1689737291469aj38xNVLK", "mask_name" : "mn_test", "mask_status" : "MASK_EFFECTIVE", "resource_id" : "dse23xw43", "namespace" : "SYS.E CS ", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ]}

URI POST /v2/{project_id}/notification-masks/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID。 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ 表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 缺省值：100 正则匹配：^([1-9]|[1-9][0-9]|100)$

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 资源分组总数 最小值：0 最大值：1000 resource_groups Array of OneResourceGroupResp objects 资源分组列表 数组长度：0 - 100 表5 OneResourceGroupResp 参数 参数类型 描述 group_name String 资源分组的名称 正则匹配：^((([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)$ group_id String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 create_time String 资源分组的创建时间 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)$ type String 资源分组添加资源方式，取值只能为EPS（同步企业项目）,TAG（标签动态匹配）,Manual（手动添加） 枚举值： EPS TAG Manual 状态码： 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

响应示例 状态码： 200 OK { "resource_groups" : [ { "group_name" : "group1", "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "0", "type" : "Manual" }, { "group_name" : "band", "type" : "EPS", "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "d61d4705-5658-42f5-8e0c-70eb34d17b02" }, { "group_name" : "group2", "type" : "TAG", "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "0" } ], "count" : 3}

URI GET /v2/{project_id}/resource-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 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)$ group_name 否 String 资源分组名称，支持模糊查询 最小长度：1 最大长度：128 group_id 否 String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 offset 否 Integer 分页查询时查询的起始位置，表示从第几条数据开始，默认为0 最小值：0 最大值：10000 limit 否 Integer 分页查询时每页的条目数，取值[1,100]，默认值为100 最小值：1 最大值：100 type 否 String 资源分组添加资源方式，取值只能为EPS（同步企业项目）,TAG（标签动态匹配）,Manual（手动添加），不传代表查询所有资源分组类型,COMB（智能添加-组合匹配） 枚举值： EPS TAG Manual COMB

响应示例 状态码： 200 OK { "alarms" : [ { "alarm_id" : "al123232232341232132", "name" : "alarm1", "description" : "hello world", "namespace" : "SYS.ECS", "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" } ]}

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

请求参数 表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参数 参数 参数类型 描述 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

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

响应示例 状态码： 200 OK { "widget_id" : "wg1234567890123456789012", "metrics" : [ { "namespace" : "SYS.ECS", "dimensions" : { "name" : "instance_id", "filter_type" : "specific_instances", "values" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ] }, "metric_name" : "cpu_util", "alias" : [ "cpuutilalias" ], "extra_info" : { "origin_metric_name" : "cpu_util", "metric_prefix" : "cpu", "metric_type" : "type", "custom_proc_name" : "app.sh" } } ], "view" : "view", "metric_display_mode" : "single", "threshold" : 0.7, "threshold_enabled" : true, "title" : "widget_title", "properties" : { "filter" : "topN", "topN" : 100, "order" : "desc" }, "location" : { "left" : 0, "top" : 0, "width" : 4, "height" : 3 }, "unit" : "%", "create_time" : 1111111111111}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 widget_id String 视图id 正则匹配：^wg([a-z]|[A-Z]|[0-9]){22}$ metrics Array of WidgetMetric objects 指标列表 数组长度：1 - 200 title String 监控视图标题 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|:|;|\(|\)|\.|~|（|）)+$ threshold Double 监控视图指标的阈值 最小值：0 最大值：1.7976931348623157E308 threshold_enabled Boolean 阈值是否展示，true:展示，false:不展示 view String 监控视图图表类型, bar条形图，line折线图，bar_chart柱状图，table表格，circular_bar环形柱状图，area_chart面积图 枚举值： bar line bar_chart table circular_bar area_chart metric_display_mode String 指标展示类型，single 单指标展示，multiple 多指标展示 枚举值： single multiple properties properties object 额外信息 location location object 监控视图图表坐标 unit String 单位 create_time Long 监控看板创建时间 最小值：1111111111111 最大值：9999999999999 表4 WidgetMetric 参数 参数类型 描述 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]|_)*$ dimensions DimensionInfo object 维度信息列表 metric_name String 指标名称 最小长度：1 最大长度：96 正则匹配：^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$ alias Array of strings 监控视图的指标别名列表 最小长度：1 最大长度：128 数组长度：0 - 200 extra_info ExtraInfo object 指标信息 表5 DimensionInfo 参数 参数类型 描述 name String 维度名称，多维度用逗号分隔，各服务支持的维度可参考：“服务维度名称” 最小长度：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}$ filter_type String 资源类型, all_instances: 全部资源, specific_instances: 指定资源 枚举值： all_instances specific_instances values Array of strings 维度值列表 最小长度：1 最大长度：1024 数组长度：0 - 200 表6 ExtraInfo 参数 参数类型 描述 origin_metric_name String 指标名称 最小长度：1 最大长度：4096 正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_prefix String 指标名称前缀 最小长度：1 最大长度：4096 正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_type String 指标类型 最小长度：1 最大长度：32 正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ custom_proc_name String 自定义进程名称 最小长度：1 最大长度：250 表7 properties 参数 参数类型 描述 filter String 聚合类型，目前只有TopN这一种类型，折线图不支持该参数 枚举值： topN topN Integer Top前N个；折线图时为随机展示的时序数据条数 最小值：1 最大值：2147483647 缺省值：100 order String 排序字段，asc正序，desc倒序，折线图不支持该参数 枚举值： asc desc 表8 location 参数 参数类型 描述 top Integer 监控视图的上坐标 最小值：0 最大值：2147483647 left Integer 监控视图的左坐标 最小值：0 最大值：9 width Integer 监控视图图表宽度 最小值：3 最大值：12 height Integer 监控视图图表高度 最小值：3 最大值：2147483647 状态码： 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 状态码： 500 表11 响应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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 resources Array of Resource objects 通知屏蔽资源列表 数组长度：1 - 100 count Integer 资源总数 最小值：0 最大值：100 表5 Resource 参数 参数类型 描述 namespace String 资源命名空间，例如弹性云服务器命名空间(格式为service.item；service和item必须是字符串，以字母开头，可包含0-9/a-z/A-Z/_；长度范围[3,32]。) 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 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求id 最小长度：0 最大长度：256

URI GET /v2/{project_id}/notification-masks/{notification_mask_id}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID。 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ notification_mask_id 是 String 屏蔽规则ID 最小长度：1 最大长度：64 正则匹配：^([a-z]|[A-Z]|[0-9]){1,64}$ 表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 缺省值：100 正则匹配：^([1-9]|[1-9][0-9]|100)$

响应示例 状态码： 200 批量查询通知屏蔽规则资源列表成功 { "resources" : [ { "namespace" : "SYS.ECS", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ], "count" : 100}

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

响应参数 状态码： 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

响应示例 状态码： 200 OK { "group_name" : "band", "type" : "TAG", "tags" : [ { "key" : "Resource", "value" : "VPC" }, { "key" : "Usage", "value" : "Tmp" } ], "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "0"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 group_name String 资源分组的名称 正则匹配：^((([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)$ group_id String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 create_time String 资源分组的创建时间 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)$ type String 资源分组添加资源方式，取值只能为EPS（同步企业项目）,TAG（标签动态匹配）,Manual（手动添加） 枚举值： EPS TAG Manual association_ep_ids Array of strings 该资源分组内包含的资源来源的企业项目ID，type为EPS时必传 数组长度：1 - 1 tags Array of ResourceGroupTagRelation objects 标签动态匹配时的关联标签,type为TAG时该字段不为空 数组长度：1 - 10 表4 ResourceGroupTagRelation 参数 参数类型 描述 key String 键 最小长度：1 最大长度：36 value String 值 最小长度：1 最大长度：42 状态码： 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

响应示例 状态码： 200 修改告警规则告警通知信息成功 { "notification_enabled" : true, "alarm_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "ok_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "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 是否开启告警通知，值为true时，其他字段均必选，值为false时，其他字段可不选 alarm_notifications 否 Array of Notification objects 告警触发的动作 ok_notifications 否 Array of Notification objects 告警恢复触发的动作 notification_begin_time 否 String 告警通知开启时间 notification_end_time 否 String 告警通知关闭时间 表4 Notification 参数 是否必选 参数类型 描述 type 是 String 通知类型, notification代表通过SMN通知 正则匹配：^(notification|autoscaling|ecsRecovery|contact|contactGroup|iecAction)$ notification_list 是 Array of strings 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notification_list列表不能为空。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notification_list值保持一致。 数组长度：0 - 20

请求示例 修改告警规则告警通知信息 { "notification_enabled" : true, "alarm_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "ok_notifications" : [ { "type" : "", "notification_list" : [ ] } ], "notification_begin_time" : "00:00", "notification_end_time" : "23:59"}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 notification_enabled Boolean 是否开启告警通知 alarm_notifications Array of Notification objects 告警触发的动作 ok_notifications Array of Notification objects 告警恢复触发的动作 notification_begin_time String 告警通知开启时间 notification_end_time String 告警通知关闭时间 表6 Notification 参数 参数类型 描述 type String 通知类型, notification代表通过SMN通知 正则匹配：^(notification|autoscaling|ecsRecovery|contact|contactGroup|iecAction)$ notification_list Array of strings 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。当type为notification时，notification_list列表不能为空。 说明：若alarm_action_enabled为true，对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时，notification_list值保持一致。 数组长度：0 - 20 状态码： 400 表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

请求示例 { "mask_name" : "mn_test", "relation_ids" : [ "al123232232341232132" ], "relation_type" : "ALARM_RULE", "resources" : [ { "namespace" : "SYS.ECS", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ], "mask_type" : "START_END_TIME", "start_date" : "yyyy-MM-dd", "start_time" : "HH:mm:ss", "end_date" : "yyyy-MM-dd", "end_time" : "HH:mm:ss"}

响应参数 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求id 最小长度：0 最大长度：256 状态码： 500 表7 响应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 表3 请求Body参数 参数 是否必选 参数类型 描述 mask_name 是 String 屏蔽规则名称，只能为字母、数字、汉字、-、_，最大长度为64 relation_ids 否 Array of strings 关联编号，relation_type为ALARM_RULE时填屏蔽的告警规则编号；relation_type为RESOURCE_POLICY_NOTIFICATION、RESOURCE_POLICY_ALARM时填屏蔽的告警策略编号； 数组长度：1 - 100 relation_type 否 String 关联类型。ALARM_RULE：关联告警规则，RESOURCE：关联资源，RESOURCE_POLICY_NOTIFICATION：关联资源策略屏蔽告警通知，RESOURCE_POLICY_ALARM：关联资源策略不计算告警。 枚举值： ALARM_RULE RESOURCE RESOURCE_POLICY_NOTIFICATION RESOURCE_POLICY_ALARM resources 是 Array of Resource objects 关联资源 数组长度：1 - 100 mask_type 是 String 屏蔽类型。START_END_TIME：按起止时间屏蔽，FOREVER_TIME：永久时间屏蔽，CYCLE_TIME：按周期时间屏蔽。 枚举值： START_END_TIME FOREVER_TIME CYCLE_TIME start_date 否 String 屏蔽起始日期，yyyy-MM-dd。 start_time 否 String 屏蔽起始时间，HH:mm:ss。 end_date 否 String 屏蔽截止日期，yyyy-MM-dd。 end_time 否 String 屏蔽截止时间，HH:mm:ss。 表4 Resource 参数 是否必选 参数类型 描述 namespace 是 String 资源命名空间，例如弹性云服务器命名空间(格式为service.item；service和item必须是字符串，以字母开头，可包含0-9/a-z/A-Z/_；长度范围[3,32]。) dimensions 是 Array of Dimension objects 资源的维度信息 数组长度：1 - 4 表5 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}$