文档首页/ 应用运维管理 AOM/ API参考/ API/ 仪表盘(Beta)/ 查询仪表盘分组列表
更新时间：2024-12-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询仪表盘分组列表

功能介绍

该接口用于查询仪表盘分组列表。（该接口在邀测中，受限开放，如有需求可以通过提交工单提申请开放此接口。）

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/aom/dashboards-folder

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

Content-Type

是

String

指定类型为application/json。

Enterprise-Project-Id

否

String

企业项目id。

  • 查询单个企业项目下实例，填写企业项目id。
  • 查询所有企业项目下实例，填写“all_granted_eps”。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

DashBoardsFolder

Array of DashBoardsFolder objects

仪表盘分组列表。
表4 DashBoardsFolder

参数

参数类型

描述

created

String

仪表盘分组创建时间。

updated

String

仪表盘分组更新时间。

created_by

String

仪表盘分组创建账号。

dashboard_ids

Array of strings

仪表盘分组下仪表盘id列表。

display

String

是否展示仪表盘分组。

enterprise_project_id

String

企业项目id。

folder_id

String

仪表盘分组id。

folder_title

String

仪表盘分组名称。

folder_title_en

String

仪表盘分组英文名称。

is_template

String

仪表盘分组是否为默认仪表盘分组。

请求示例

查询仪表盘分组列表

https://{Endpoint}/v2/{project_id}/aom/dashboards-folder

响应示例

状态码： 200

OK 请求响应成功。

[ {
  "created" : 1712474334896,
  "dashboard_ids" : [ "07994ceb-****-****-****-1e****3d****" ],
  "display" : true,
  "enterprise_project_id" : "0",
  "folder_id" : "16ea61ea-**-****-****-cd****a3190a",
  "folder_title" : "仪表盘",
  "folder_title_en" : "Historical Dashboards",
  "is_template" : false,
  "updated" : 0
} ]

状态码

状态码

描述

200

OK 请求响应成功。

错误码

请参见错误码。

父主题： 仪表盘(Beta)

相关文档