查询仪表盘分组列表 - ListDashboardsFolder
功能介绍
该接口用于查询仪表盘分组列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
aom:view:get
Read
-
-
-
-
URI
GET /v2/{project_id}/aom/dashboards-folder
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
请求参数
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of DashBoardsFolder objects |
仪表盘分组列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
created |
String |
仪表盘分组创建时间。 |
|
updated |
String |
仪表盘分组更新时间。 |
|
created_by |
String |
仪表盘分组创建账号。 |
|
dashboard_ids |
Array of strings |
仪表盘分组下仪表盘id列表。 |
|
display |
String |
是否展示仪表盘分组。 |
|
enterprise_project_id |
String |
企业项目id。获取方式请参见:获取企业项目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 请求响应成功。 |
错误码
请参见错误码。