查询监控看板列表
功能介绍
查询监控看板列表
接口约束
目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得、亚太-马尼拉6个局点不支持该接口
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/dashboards
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户ID。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见“获取项目ID”。 约束限制: 不涉及。 取值范围: 字符串的长度必须在 1 到 64个字符之间。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
监控看板名称 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ |
dashboard_id |
否 |
String |
监控看板id 正则匹配:^db([a-z]|[A-Z]|[0-9]){22} |
dashboard_type |
否 |
String |
监控看板类型, monitor_dashboard表示监控大盘,other表示自定义看板 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1,最大为16384。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
dashboards |
Array of DashBoardInfo objects |
监控看板列表 |
参数 |
参数类型 |
描述 |
---|---|---|
dashboard_id |
String |
监控看板id 正则匹配:^db([a-z]|[A-Z]|[0-9]){22} |
dashboard_name |
String |
自定义监控看板名称 正则匹配:^([\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 |
监控看板的创建用户名 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ |
create_time |
Long |
监控看板创建时间 取值范围: 1111111111111-9999999999999 |
widgets_num |
Integer |
看板下的视图总数 取值范围: 0-50 |
namespace |
String |
命名空间 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ |
sub_product |
String |
子产品标识 |
dashboard_template_id |
String |
监控大盘模板id 正则匹配:^mb([a-z]|[A-Z]|[0-9]){22} |
row_widget_num |
Integer |
监控视图展示模式,0表示自定义坐标,1代表每行一个 取值范围: 0-3 默认取值: 3 |
is_favorite |
Boolean |
监控看板是否标记收藏, true: 收藏, false: 未收藏 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
请求示例
无
响应示例
状态码: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 } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request, 请求错误 |
401 |
Unauthorized, 未提供认证信息,或认证信息错误 |
500 |
Internal Server Error, 请求未完成, 服务异常 |
错误码
请参见错误码。