文档首页/ 应用运维管理 AOM/ API参考/ API/ 仪表盘/ 查询仪表盘详情 - ShowDashBoard
更新时间：2025-10-23 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询仪表盘详情 - ShowDashBoard

功能介绍

该接口用于查询仪表盘详情。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    aom:view:get

    Read

    -

    -

    -

    -

URI

GET /v2/{project_id}/aom/dashboards/{dashboard_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。

dashboard_id

是

String

仪表盘id。
表2 Query参数

参数

是否必选

参数类型

描述

version

是

String

仪表盘版本号。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。获取方式请参见：获取Token。

Content-Type

否

String

消息体的类型（格式）。指定类型为“application/json”。

Enterprise-Project-Id

否

String

企业项目id。获取方式请参见：获取企业项目ID。

  • 查询单个企业项目下实例，填写企业项目id。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

project_id

String

项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。

dashboard_type

String

仪表盘类型。

dashboard_title

String

仪表盘名称。

dashboard_title_en

String

仪表盘英文名称。

dashboard_id

String

仪表盘id。

version

String

仪表盘版本。

enterprise_project_id

String

仪表盘企业项目id。获取方式请参见：获取企业项目ID。

folder_name

String

仪表盘分组名称。

folder_id

String

仪表盘分组id。

sync_data

String

待同步的仪表盘数。

is_create_action

Boolean

是否创建

  • false：更新

  • true：创建

枚举值：

  • true

  • false

dashboard_tags

Array of Map<String,String> objects

仪表盘标签列表。

is_favorite

Boolean

是否收藏

  • true：收藏

  • false：不收藏

枚举值：

  • true

  • false

created

Long

仪表盘创建时间。

updated

Long

仪表盘更新时间。

created_by

String

创建仪表盘的账号名称。

updated_by

String

更新仪表盘的账号名称。

charts

Object

仪表盘图表详情。

templating

Object

仪表盘变量列表。

display

String

是否展示。

query_count

String

查询总次数。

time_range

String

默认查询时间范围。

请求示例

查询仪表盘id为f804-03-4f-b**9-bf32f**f的详情

https://{Endpoint}/v2/{project_id}/aom/dashboards/f80****4-0**3-4**f-b**9-b****f32f**f

响应示例

状态码：200

OK 请求响应成功。

{
  "created" : 1719327521188,
  "updated" : 1719327521188,
  "templating" : { },
  "display" : true,
  "project_id" : "2a****56cc****7f83****891b****cf",
  "dashboard_type" : "dashboard",
  "dashboard_title" : "aom_dashboard",
  "dashboard_id" : "f80****4-0**3-4**f-b**9-b****f32f**f",
  "version" : "v1",
  "enterprise_project_id" : "0",
  "folder_name" : "仪表盘分组",
  "sync_data" : "{\"dashboard_id\":\"f80****4-0**3-4**f-b**9-b****f32f**f\",\"version\":\"v1\",\"folder_id\":null,\"is_create_action\":true}",
  "is_create_action" : false,
  "dashboard_tags" : [ { } ],
  "is_favorite" : false,
  "created_by" : "aom_ops_user2",
  "query_count" : 0
}

状态码

状态码

描述

200

OK 请求响应成功。

错误码

请参见错误码。

父主题： 仪表盘