# 批量更新监控视图 - BatchUpdateWidgets #### 功能介绍 批量更新监控视图 #### 接口约束 目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得、亚太-马尼拉6个局点不支持该接口 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=BatchUpdateWidgets&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:widgets:put | Write | - | ces:namespace | - | - | #### URI POST /v2/{project_id}/widgets/batch-update 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 字符串的长度必须在 1 到 64个字符之间。 **默认取值**: 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为64。 **默认取值**: 默认使用application/json; charset=UTF-8。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。Token认证，具体操作请参考[认证鉴权](https://support.huaweicloud.com/api-ces/ces_03_0011.html)。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为16384。 **默认取值**: 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | \[数组元素\] | 是 | Array of [UpdateWidgetInfo] objects | **参数解释** 待修改的监控视图列表 **约束限制** 包含的监控视图对象个数为\[1,50\] | 表4UpdateWidgetInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | group_id | 否 | String | **参数解释** 视图分区id **约束限制** 不涉及 **取值范围** 字符串必须以dg开头，后跟22个字母和数字，总长度为24个字符或者为default，default代表不分组 **默认取值** 不涉及 | | widget_id | 是 | String | **参数解释** 视图id **约束限制** 不涉及 **取值范围** 字符串必须以wg开头，后跟22个字母和数字，总长度为24个字符 **默认取值** 不涉及 | | metrics | 否 | Array of [WidgetMetric] objects | **参数解释** 指标列表 **约束限制** 包含的指标对象个数为\[1,200\] | | title | 否 | String | **参数解释** 监控视图标题 **约束限制** 不涉及 **取值范围** 字符串可以包含中文字符，字母，数字，下划线（_），横线（-），冒号（:），分号（;），左圆括号（(），右圆括号（)），句号（.），波浪线（\~）， 中文左括号（（），中文右括号（））长度为\[1,128\]个字符 **默认取值** 不涉及 | | threshold | 否 | Double | **参数解释** 监控视图指标的阈值 **约束限制** 不涉及 **取值范围** 阈值为\[0,1.7976931348623157e+308\] **默认取值** 不涉及 | | threshold_enabled | 否 | Boolean | **参数解释** 阈值是否展示 **约束限制** 不涉及 **取值范围** - true 展示 - false 不展示 **默认取值** 不涉及 | | view | 否 | String | **参数解释** 监控视图图表类型 **约束限制** 不涉及 **取值范围** 枚举值： - bar 条形图 - line 折线图 - bar_chart 柱状图 - table 表格 - circular_bar 环形柱状图 - area_chart 面积图 - gauge 仪表盘 - stat 数字 **默认取值** 不涉及 | | metric_display_mode | 否 | String | **参数解释** 指标展示类型 **约束限制** 不涉及 **取值范围** 枚举值： - single 单指标展示 - multiple 多指标展示 **默认取值** 不涉及 | | properties | 否 | [properties] object | **参数解释** 视图展示配置 **约束限制** 不涉及 | | location | 否 | [location] object | **参数解释** 监控视图图表坐标 **约束限制** 不涉及 | | unit | 否 | String | **参数解释** 单位 **约束限制** 不涉及 **取值范围** 长度为\[0,32\]个字符 **默认取值** 不涉及 | 表5WidgetMetric | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | namespace | 是 | String | **参数解释** 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)**约束限制** 不涉及 **取值范围** 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 **默认取值** 不涉及 | | dimensions | 是 | [DimensionInfo] object | **参数解释** 维度信息列表。 **约束限制** 不涉及 | | metric_name | 是 | String | **参数解释** 多个指标名称 **约束限制** 不涉及 **取值范围** 长度为\[1,1080\]个字符，多个指标名称之间用逗号隔开 **默认取值** 不涉及 | | alias | 否 | Array of strings | **参数解释** 监控视图的指标别名列表 **约束限制** 当资源类型为指定资源时才允许传该参数 包含的指标别名对象个数为\[0,200\] | | extra_info | 否 | [ExtraInfo] object | **参数解释** 指标信息 **约束限制** 不涉及 | | y_axis_position | 否 | String | **参数解释** 阈值线所在的Y轴位置 **约束限制** 不涉及 **取值范围** 枚举值： - left 左Y轴 - right 右Y轴 **默认取值** 不涉及 | | rollup_enable | 否 | Boolean | **参数解释** 是否开启聚合 **约束限制** 当rollup_enable开启时，rollup_filter和rollup_dimension必填 **取值范围** - true：表示开启聚合 - false：表示不开启聚合 **默认取值** false | | rollup_filter | 否 | String | **参数解释** 聚合规则 **约束限制** 当rollup_enable开启时，rollup_filter和rollup_dimension必填 **取值范围** - last:最新值 - max:最大值 - min:最小值 - average:平均值 - sum:求和值 **默认取值** 不涉及 | | rollup_dimension | 否 | String | **参数解释** 聚合维度 **约束限制** 不涉及 **取值范围** 长度为\[1,32\]个字符 **默认取值** 不涉及 | | last_week_compare_enable | 否 | Boolean | **参数解释** 是否展示同比（上周同一时间）数据 **约束限制** 不涉及 **取值范围** - true:展示 - false:不展示 **默认取值** 不涉及 | | yesterday_compare_enable | 否 | Boolean | **参数解释** 是否展示环比（昨天同一时间）数据 **约束限制** 不涉及 **取值范围** - true:展示 - false:不展示 **默认取值** 不涉及 | | metric_dimension | 否 | String | **参数解释** 维度名称，多维度用逗号分隔，各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。必须以字母开头，只能包含0-9/a-z/A-Z/_/-，多维度用","分隔，每个维度的最大长度为32。总长度为\[1,131\]个字符。目前最大支持4个维度。举例：单维度场景：instance_id；多维度场景：instance_id,disk。 **约束限制** 不涉及 **取值范围** 长度为\[1,131\]个字符 **默认取值** 不涉及 | | top_num | 否 | Integer | **参数解释** 展示数据数量 **约束限制** 不涉及 **取值范围** 最小值为1，最大值为200 **默认取值** 不涉及 | | unit | 否 | String | **参数解释** 单位 **约束限制** 不涉及 **取值范围** 长度为\[0,32\]个字符 **默认取值** 不涉及 | | order | 否 | String | **参数解释** 排序字段 **约束限制** 不涉及 **取值范围** - asc:正序 - desc:倒序 **默认取值** 不涉及 | | topn_metric_name | 否 | String | **参数解释** 资源的监控指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **约束限制** 不涉及 **取值范围** 长度为\[1,96\]个字符 **默认取值** 不涉及 | 表6DimensionInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**： 维度名称。 **约束限制** 不涉及 **取值范围**： 多维度用逗号分隔，各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。必须以字母开头，只能包含0-9/a-z/A-Z/_/-，多维度用","分隔，每个维度的最大长度为32。总长度为\[1,131\]个字符。目前最大支持4个维度。举例：单维度场景：instance_id；多维度场景：instance_id,disk **默认取值** 不涉及 | | filter_type | 是 | String | **参数解释**： 资源类型。 **约束限制** 1、view参数取值为柱状图 条形图 环形柱状图 表格时，filter_type参数不支持指定资源类型 2、rollup_enable参数为空时，filter_type参数不支持资源分组类型 **取值范围**： - all_instances: 全部资源 - specific_instances: 指定资源 - resource_groups：资源分组 **默认取值** 不涉及 | | values | 否 | Array of strings | **参数解释**： 维度值列表。 **约束限制** 包含的维度值对象个数为\[0,200\] | 表7ExtraInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | origin_metric_name | 是 | String | **参数解释** 指标名称 **约束限制** 不涉及 **取值范围** 长度为\[1,4096\]个字符 **默认取值** 不涉及 | | metric_prefix | 否 | String | **参数解释** 指标名称前缀 **约束限制** 不涉及 **取值范围** 长度为\[1,4096\]个字符 **默认取值** 不涉及 | | metric_type | 否 | String | **参数解释** 指标类型 **约束限制** 不涉及 **取值范围** 长度为\[1,32\]个字符 **默认取值** 不涉及 | | custom_proc_name | 否 | String | **参数解释** 自定义进程名称 **约束限制** 不涉及 **取值范围** 长度为\[1,250\]个字符 **默认取值** 不涉及 | 表8properties | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | filter | 否 | String | **参数解释** 聚合类型 **约束限制** 折线图不支持该参数 **取值范围** 枚举值： - topN topN类型 **默认取值** 不涉及 | | topN | 否 | Integer | **参数解释** Top值前N个 **约束限制** 折线图时表示随机展示的时序数据条数 **取值范围** Top值为\[1,2147483647\] **默认取值** 不涉及 | | order | 否 | String | **参数解释** 排序字段 **约束限制** 折线图不支持该参数 **取值范围** 枚举值： - asc 正序 - desc 倒序 **默认取值** 不涉及 | | description | 否 | String | **参数解释** 监控视图的描述信息 **约束限制** 不涉及 **取值范围** 信息长度为\[0,200\]个字符 **默认取值** 不涉及 | | last_week_compare_enable | 否 | Boolean | **参数解释** 是否展示同比（上周同一时间）数据 **约束限制** 不涉及 **取值范围** - true 展示 - false 不展示 **默认取值** 不涉及 | | yesterday_compare_enable | 否 | Boolean | **参数解释** 是否展示环比（昨天同一时间）数据 **约束限制** 不涉及 **取值范围** - true 展示 - false 不展示 **默认取值** 不涉及 | | legend_location | 否 | String | **参数解释** 图例位置标记 **约束限制** 表格不支持该参数 **取值范围** 枚举值： - hide 隐藏图例 - right 图例放在监控视图右侧 - bottom 图例放在监控视图底部 **默认取值** 不涉及 | | legend_values | 否 | Array of strings | **参数解释** 当前时序数据需要在图例中展示的统计值名称列表 **约束限制** 表格不支持该参数，条形图和柱状图仅支持选择当前值 包含的名称对象个数为\[0,5\] | | thresholds | 否 | Array of [ThresholdInfo] objects | **参数解释** 监控视图的阈值辅助线配置 **约束限制** 包含的配置对象个数为\[0,6\] | | is_all_compare_enable | 否 | Boolean | **参数解释** 同比环比总开关是否生效 **约束限制** 不涉及 **取值范围** - true 生效 - false 不生效 **默认取值** 不涉及 | 表9ThresholdInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | threshold | 是 | Number | **参数解释** 监控视图辅助线的阈值 **约束限制** 不涉及 **取值范围** 最小值为0，最大值为2147483647 **默认取值** 不涉及 | | threshold_color | 是 | String | **参数解释** 监控视图辅助线的颜色 **约束限制** 不涉及 **取值范围** - "#B50E65":紫色 - "#F23030":红色 - "#FF8800":橙色 - "#F2E70C":黄色 **默认取值** 不涉及 | 表10location | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | top | 是 | Integer | **参数解释** 监控视图的上坐标 **约束限制** 不涉及 **取值范围** 坐标的取值范围\[0,2147483647\] **默认取值** 不涉及 | | left | 是 | Integer | **参数解释** 监控视图的左坐标 **约束限制** 不涉及 **取值范围** 坐标的取值范围\[0,9\] **默认取值** 不涉及 | | width | 是 | Integer | **参数解释** 监控视图图表宽度 **约束限制** 不涉及 **取值范围** 宽度的取值范围\[3,12\] **默认取值** 不涉及 | | height | 是 | Integer | **参数解释** 监控视图图表高度 **约束限制** 不涉及 **取值范围** 高度的取值范围\[3,2147483647\] **默认取值** 不涉及 | #### 响应参数 **状态码：200** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | widgets | Array of [BatchUpdateWidgetInfo] objects | **参数解释** 更新结果列表 | 表12BatchUpdateWidgetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | widget_id | String | **参数解释** 视图id **取值范围** 字符串必须以wg开头，后跟22个字母和数字，总长度为24个字符 | | ret_status | String | **参数解释** 修改结果 **取值范围** 枚举值： - successful 成功 - error 失败 | | error_msg | String | **参数解释** 如果失败则返回失败信息 **取值范围** 长度为\[1,2048\]个字符 | **状态码：400** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：401** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：500** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | #### 请求示例 ``` [ { "widget_id" : "wgXXXXXXXXXXXXXXXXXXXXXX", "metrics" : [ { "namespace" : "SYS.ECS", "dimensions" : { "name" : "instance_id", "filter_type" : "all_instances" }, "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" : "bar", "metric_display_mode" : "single", "threshold" : 500, "threshold_enabled" : false, "title" : "widget_title_new", "properties" : { "filter" : "topN", "topN" : 10, "order" : "asc" }, "location" : { "left" : 0, "top" : 3, "width" : 4, "height" : 3 }, "unit" : "%" } ] ``` #### 响应示例 **状态码：200** OK ``` { "widgets" : [ { "widget_id" : "wgXXXXXXXXXXXXXXXXXXXXXX", "ret_status" : "successful" }, { "widget_id" : "wg9876543210123456789012", "ret_status" : "error", "error_msg" : "record not found" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request, 请求错误 | | 401 | Unauthorized, 未提供认证信息，或认证信息错误 | | 500 | Internal Server Error, 请求未完成, 服务异常 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。