查询仪表盘列表 - ListDashBoards
功能介绍
该接口用于查询仪表盘列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
aom:view:get
Read
-
-
-
-
URI
GET /v2/{project_id}/aom/dashboards
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dashboard_type |
否 |
String |
仪表盘类型。 |
请求参数
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
page_size |
String |
当前页大小。 |
|
dashboards |
Array of Dashboard objects |
仪表盘详情列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
是否创建
枚举值：
|
|
dashboard_tags |
Array of Map<String,String> objects |
仪表盘标签列表。 |
|
is_favorite |
Boolean |
是否收藏
枚举值：
|
|
created |
Long |
仪表盘创建时间。 |
|
updated |
Long |
仪表盘更新时间。 |
|
created_by |
String |
创建仪表盘的账号名称。 |
|
updated_by |
String |
更新仪表盘的账号名称。 |
|
charts |
Object |
仪表盘图表详情。 |
|
templating |
Object |
仪表盘变量列表。 |
|
display |
String |
是否展示。 |
|
query_count |
String |
查询总次数。 |
|
time_range |
String |
默认查询时间范围。 |
请求示例
查询所有仪表盘详情
https://{Endpoint}/v2/{project_id}/aom/dashboards
响应示例
状态码：200
OK 请求响应成功。
{
"dashboards" : [ {
"created" : 1725009374,
"created_by" : "auto_admin",
"dashboard_id" : "387d****-5ff2-****-bcee-****cab9****",
"dashboard_tags" : [ {
"application_name" : "sYRN095Z_AutoAPPtest"
} ],
"dashboard_title" : "1EuBp3Hf0Df",
"dashboard_type" : "dashboard",
"display" : true,
"enterprise_project_id" : "0",
"is_create_action" : false,
"is_favorite" : false,
"project_id" : "2a47****cca5****8373****1bff****",
"query_count" : 1,
"updated" : 1733398075812,
"version" : "v1"
} ],
"page_size" : 0
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。 |
错误码
请参见错误码。
