更新时间:2024-10-30 GMT+08:00

修改监控看板

功能介绍

修改监控看板

接口约束

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

调试

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

URI

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

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

表3 请求Body参数

参数

是否必选

参数类型

描述

dashboard_name

String

自定义监控看板名称

最小长度:1

最大长度:128

正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

is_favorite

Boolean

监控看板是否标记收藏, true: 收藏, false: 未收藏

row_widget_num

Integer

监控视图展示模式,0表示自定义坐标,1代表每行一个

最小值:0

最大值:3

缺省值:3

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度:0

最大长度:256

error_msg

String

请求异常信息

最小长度:0

最大长度:256

request_id

String

请求ID

最小长度:0

最大长度:256

请求示例

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

响应示例

状态码

状态码

描述

204

No Content

400

Bad Request, 请求错误

401

Unauthorized, 未提供认证信息,或认证信息错误

500

Internal Server Error, 请求未完成, 服务异常

错误码

请参见错误码