本文导读

功能介绍
接口约束
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云监控服务 CES/ API参考/ API/ 云资源监控/ 监控视图/ 批量更新监控视图

批量更新监控视图

更新时间：2025-04-14 GMT+08:00

查看PDF

功能介绍

批量更新监控视图

接口约束

目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得、亚太-马尼拉6个局点不支持该接口

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/widgets/batch-update

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{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

表3 请求Body参数
参数	是否必选	参数类型	描述
[数组元素]	是	Array of UpdateWidgetInfo objects	待修改的监控视图列表

表4 UpdateWidgetInfo
参数	是否必选	参数类型	描述
group_id	否	String	视图分区id 正则匹配：^dg([a-z]\|[A-Z]\|[0-9]){22}\|default$
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	单位

表5 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	多个指标名称，用逗号隔开
alias	否	Array of strings	监控视图的指标别名列表最小长度：1 最大长度：128 数组长度：0 - 200
extra_info	否	ExtraInfo object	指标信息
rollup_enable	否	Boolean	是否开启聚合
rollup_filter	否	String	聚合规则，last:最新值,max:最大值,min:最小值,average:平均值,sum:求和值枚举值： last max min average sum
rollup_dimension	否	String	聚合维度
last_week_compare_enable	否	Boolean	是否展示同比（上周同一时间）数据，true:展示，false:不展示
yesterday_compare_enable	否	Boolean	是否展示环比（昨天同一时间）数据，true:展示，false:不展示
metric_dimension	否	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}$
top_num	否	Integer	展示数据数量最小值：1 最大值：200
unit	否	String	单位
order	否	String	排序字段，asc正序，desc倒序枚举值： asc desc
topn_metric_name	否	String	资源的监控指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务的指标名称可查看：“服务指标名称”。

表6 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

表7 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

表8 properties
参数	是否必选	参数类型	描述
filter	否	String	聚合类型，目前只有TopN这一种类型，折线图不支持该参数枚举值： topN
topN	否	Integer	Top值前N个;折线图时表示随机展示的时序数据条数最小值：1 最大值：2147483647 缺省值：100
order	否	String	排序字段，asc正序，desc倒序，折线图不支持该参数枚举值： 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表示图例放在监控视图底部，表格不支持该参数枚举值： hide right bottom
legend_values	否	Array of strings	当前时序数据需要在图例中展示的统计值名称列表，表格不支持该参数，条形图和柱状图仅支持选择当前值数组长度：0 - 5 枚举值： last max min avg sum
thresholds	否	Array of ThresholdInfo objects	监控视图的阈值辅助线配置数组长度：0 - 6
is_all_compare_enable	否	Boolean	同比环比总开关是否生效;true:生效；false:不生效

表9 ThresholdInfo
参数	是否必选	参数类型	描述
threshold	是	Number	监控视图辅助线的阈值最小值：0 最大值：2147483647
threshold_color	是	String	监控视图辅助线的颜色,"#B50E65"紫色,"#F23030"红色,"#FF8800"橙色,"#F2E70C"黄色枚举值： #B50E65 #F23030 #FF8800 #F2E70C

**表10** location
参数	是否必选	参数类型	描述
top	是	Integer	监控视图的上坐标最小值：0 最大值：2147483647
left	是	Integer	监控视图的左坐标最小值：0 最大值：9
width	是	Integer	监控视图图表宽度最小值：3 最大值：12
height	是	Integer	监控视图图表高度最小值：3 最大值：2147483647

响应参数

状态码：200

**表11** 响应Body参数
参数	参数类型	描述
widgets	Array of BatchUpdateWidgetInfo objects	更新结果列表数组长度：1 - 50

**表12** BatchUpdateWidgetInfo
参数	参数类型	描述
widget_id	String	视图id 正则匹配：^wg([a-z]\|[A-Z]\|[0-9]){22}$
ret_status	String	修改结果；成功: successful, 失败: error 枚举值： successful error
error_msg	String	如果失败则返回失败信息最小长度：1 最大长度：2048

状态码：400

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码：401

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码：500

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

请求示例

[ {
  "widget_id" : "wgXXXXXXXXXXXXXXXXXXXXXX",
  "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" : 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

{
  "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, 请求未完成, 服务异常

错误码

请参见错误码。

父主题： 监控视图

上一篇：删除指定监控视图

下一篇：资源标签管理

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

批量更新监控视图

功能介绍

接口约束

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈