修改监控看板 - UpdateDashboard

功能介绍

修改监控看板

接口约束

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

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ces:dashboards:put
Write
dashboard *
g:EnterpriseProjectId
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ces:dashboards:put	Write	dashboard *	g:EnterpriseProjectId	-	-

URI

PUT /v2/{project_id}/dashboards/{dashboard_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。约束限制: 不涉及。取值范围: 字符串的长度必须在 1 到 64个字符之间。默认取值: 不涉及。
dashboard_id	是	String	参数解释: 监控看板id 约束限制: 不涉及。取值范围: 以db开头，包含22个字母和数字，长度为24个字符默认取值: 不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	否	String	参数解释: 发送的实体的MIME类型。约束限制: 不涉及。取值范围: 最小字符数量为1，最大为64。默认取值: 默认使用application/json; charset=UTF-8。
X-Auth-Token	否	String	参数解释: 用户Token。约束限制: 不涉及。取值范围: 最小字符数量为1，最大为16384。默认取值: 不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
dashboard_name	否	String	参数解释自定义监控看板名称约束限制不涉及取值范围字符串包含中文字符，字母，数字，下划线（_），横线（-）长度为[1,128]个字符默认取值不涉及
is_favorite	否	Boolean	参数解释监控看板是否标记收藏约束限制不涉及取值范围 true 收藏 false 未收藏默认取值不涉及
row_widget_num	否	Integer	参数解释监控视图展示模式约束限制不涉及取值范围 0 自定义坐标 1 每行一个 2 每行两个 3 每行三个 4 每行四个默认取值不涉及
extend_info	否	ExtendInfo object	参数解释看板相关拓展信息约束限制不涉及

表4 ExtendInfo
参数	是否必选	参数类型	描述
filter	否	String	参数解释表示指标聚合方式约束限制不涉及取值范围枚举值： average 平均值 min 最小值 max 最大值 sum 求和值默认取值不涉及
period	否	String	参数解释表示指标聚合周期约束限制不涉及取值范围 1 原始值 60 一分钟 300 5分钟 1200 20分钟 3600 1小时 14400 4小时 86400 1天默认取值不涉及
display_time	否	Integer	参数解释展示时间约束限制不涉及取值范围枚举值： 0 自定义时间 5 5分钟 15 15分钟 30 30分钟 60 1小时 120 2小时 180 3小时 720 12小时 1440 24小时 10080 7天 43200 30天默认取值不涉及
refresh_time	否	Integer	参数解释刷新时间约束限制不涉及取值范围枚举值： 0 不刷新 10 10秒 60 1分钟 300 5分钟 1200 20分钟默认取值不涉及
from	否	Long	参数解释开始时间约束限制不涉及取值范围时间戳取值为[0,9999999999999] 默认取值不涉及
to	否	Long	参数解释结束时间约束限制不涉及取值范围时间戳取值为[0,9999999999999] 默认取值不涉及
screen_color	否	String	参数解释监控大屏背景颜色约束限制不涉及取值范围背景颜色长度最长为100个字符默认取值不涉及
enable_screen_auto_play	否	Boolean	参数解释监控大屏是否自动切换约束限制不涉及取值范围 true 是 false 否默认取值不涉及
time_interval	否	Integer	参数解释监控大屏自动切换时间间隔约束限制不涉及取值范围枚举值： 10000 10秒 30000 30秒 60000 1分钟默认取值不涉及
enable_legend	否	Boolean	参数解释是否开启图例约束限制不涉及取值范围 true 是 false 否默认取值不涉及
full_screen_widget_num	否	Integer	参数解释大屏展示视图数量约束限制可以取的值必须与console页面可选值保持一致取值范围视图数量为[0,65535] 默认取值不涉及

响应参数

状态码：204

No Content

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

状态码：500

表7 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码
error_msg	String	请求异常信息
request_id	String	请求ID

请求示例

{
  "dashboard_name" : "dashboard_name_new",
  "is_favorite" : true,
  "row_widget_num" : 0
}

响应示例

无

状态码

状态码	描述
204	No Content
400	Bad Request, 请求错误
401	Unauthorized, 未提供认证信息，或认证信息错误
500	Internal Server Error, 请求未完成, 服务异常