查询监控看板列表
功能介绍
查询监控看板列表
接口约束
目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得、亚太-马尼拉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。 约束限制: 不涉及。 取值范围: 只能包含小写字母、数字、“-”、“_”,可以自定义企业项目ID,长度为36个字符。也可以为0(代表默认企业项目ID),all_granted_eps(代表所有企业项目ID)。 默认取值: 不涉及。 |
is_favorite |
否 |
Boolean |
参数解释: 指定企业项目下监控看板是否收藏。 约束限制: 填此参数时,enterprise_id必填。 取值范围:
默认取值: 不涉及。 |
dashboard_name |
否 |
String |
参数解释: 监控看板名称。 约束限制: 不涉及。 取值范围: 长度为[1,128]个字符,只允许中文、英文、数字0-9、_和- 默认取值: 不涉及。 |
dashboard_id |
否 |
String |
参数解释: 监控看板id。 约束限制: 不涉及。 取值范围: 以db开头,包含22个字母和数字,长度为24个字符 默认取值: 不涉及。 |
dashboard_type |
否 |
String |
参数解释: 监控看板类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1,最大为16384。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
dashboards |
Array of DashBoardInfo objects |
参数描述: 监控看板列表 |
参数 |
参数类型 |
描述 |
---|---|---|
dashboard_id |
String |
参数描述: 监控看板id 取值范围 以db开头,包含22个字母和数字,长度为24个字符 |
dashboard_name |
String |
参数解释 自定义监控看板名称 取值范围 长度为[1,128]个字符,只允许中文、英文、数字0-9、_和- |
enterprise_id |
String |
参数解释 企业项目ID 取值范围 只能包含小写字母、数字、“-”、“_”,可以自定义企业项目ID,长度为36个字符。也可以为0(代表默认企业项目ID)。 |
creator_name |
String |
参数解释 监控看板的创建用户名 取值范围 长度为[1,128]个字符,只允许中文、英文、数字0-9、_和- |
create_time |
Long |
参数解释 监控看板创建时间 取值范围 最小值为1111111111111,最大值为9999999999999 |
widgets_num |
Integer |
参数解释 看板下的视图总数 取值范围 最小值为0,最大值为50 |
namespace |
String |
参数解释 查询服务的命名空间,各服务命名空间请参考“服务命名空间” 取值范围 格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 |
sub_product |
String |
参数解释 子产品标识 取值范围 长度为[1,128]个字符 |
dashboard_template_id |
String |
参数解释 监控大盘模板id 取值范围 以mb开头,包含22个字母和数字,长度为24个字符 |
row_widget_num |
Integer |
参数解释 每行展示视图数量 取值范围
|
is_favorite |
Boolean |
参数解释 监控看板是否标记收藏 取值范围
|
状态码: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, 请求未完成, 服务异常 |
错误码
请参见错误码。