华为云用户手册

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 dashboard_id String 监控看板id 正则匹配：^db([a-z]|[A-Z]|[0-9]){22} 状态码： 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 状态码： 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参数 参数 是否必选 参数类型 描述 notification_mask_ids 是 Array of strings 屏蔽规则编号 数组长度：1 - 100

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 notification_mask_ids Array of strings 删除成功的屏蔽规则ID 数组长度：1 - 100 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求id 最小长度：0 最大长度：256 状态码： 404 表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

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 succeed_count Integer 成功添加的资源数目 最小值：0 最大值：1000 状态码： 400 表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参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of Resource objects 资源信息 数组长度：1 - 1000 表4 Resource 参数 是否必选 参数类型 描述 namespace 是 String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” 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}$

URI POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-create 表1 路径参数 参数 是否必选 参数类型 描述 group_id 是 String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 project_id 是 String 租户ID 最小长度：1 最大长度：64

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

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

响应示例 状态码： 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

响应示例 状态码： 200 OK [ { "widget_id" : "wg1234567890123456789012", "metrics" : [ { "namespace" : "SYS.E CS ", "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 表4 响应Body参数 参数 参数类型 描述 widgets Array of WidgetInfoWithId objects 监控视图列表 数组长度：0 - 50 表5 WidgetInfoWithId 参数 参数类型 描述 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 表6 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 指标信息 表7 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 表8 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 表9 properties 参数 参数类型 描述 filter String 聚合类型，目前只有TopN这一种类型，折线图不支持该参数 枚举值： topN topN Integer Top前N个；折线图时为随机展示的时序数据条数 最小值：1 最大值：2147483647 缺省值：100 order String 排序字段，asc正序，desc倒序，折线图不支持该参数 枚举值： asc desc 表10 location 参数 参数类型 描述 top Integer 监控视图的上坐标 最小值：0 最大值：2147483647 left Integer 监控视图的左坐标 最小值：0 最大值：9 width Integer 监控视图图表宽度 最小值：3 最大值：12 height Integer 监控视图图表高度 最小值：3 最大值：2147483647 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表12 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表13 响应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 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：16000

URI GET /v2/{project_id}/dashboards/{dashboard_id}/widgets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户id 最小长度：1 最大长度：64 dashboard_id 是 String 监控看板id，以db开头，包含22个字母和数字例：db16564943172807wjOmoLyn' 数组长度：24 - 24 正则匹配：^db([a-z]|[A-Z]|[0-9]){22}$ 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 String 视图所在的分组id 正则匹配：^dg([a-z]|[A-Z]|[0-9]){22}|default$

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

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

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参数 参数 参数类型 描述 dashboards Array of DashBoardInfo objects 监控看板列表 数组长度：0 - 10 表5 DashBoardInfo 参数 参数类型 描述 dashboard_id String 监控看板id 正则匹配：^db([a-z]|[A-Z]|[0-9]){22} dashboard_name String 自定义监控看板名称 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ enterprise_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)$ creator_name String 监控看板的创建用户名 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ create_time Long 监控看板创建时间 最小值：1111111111111 最大值：9999999999999 row_widget_num Integer 监控视图展示模式，0表示自定义坐标，1代表每行一个 最小值：0 最大值：3 缺省值：3 is_favorite Boolean 监控看板是否标记收藏, true: 收藏, false: 未收藏 状态码： 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

响应示例 状态码： 200 OK { "dashboards" : [ { "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx", "dashboard_name" : "dashboard_name", "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "creator_name" : "creator_name", "create_time" : 1111111111111, "row_widget_num" : 3, "is_favorite" : false } ] }

URI GET /v2/{project_id}/dashboards 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户id 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_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|all_granted_eps)$ is_favorite 否 Boolean 指定企业项目下监控看板是否收藏，true:收藏，false:未收藏，填此参数时，enterprise_id必填 dashboard_name 否 String 监控看板名称 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ dashboard_id 否 String 监控看板id 正则匹配：^db([a-z]|[A-Z]|[0-9]){22}

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

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

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

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

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

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)$