# 查询仪表盘列表 - ListDashBoards #### 功能介绍 该接口用于查询仪表盘列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-aom/aom_04_0057.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-aom/aom_04_0031.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | aom:view:get | Read | - | - | - | - | #### URI GET /v2/{project_id}/aom/dashboards 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-aom/aom_04_0024.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | dashboard_type | 否 | String | **参数解释：** 仪表盘类型。 **约束限制：** 不涉及。 **取值范围：** - dashboard：普通仪表盘 - ELB：elb云服务相关仪表盘 - VPC：vpc云服务相关仪表盘 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。获取方式请参见：[获取Token](https://support.huaweicloud.com/api-aom/aom_04_0059.html)。 | | Content-Type | 否 | String | 消息体的类型（格式）。指定类型为"application/json"。 | | Enterprise-Project-Id | 否 | String | 企业项目id。获取方式请参见：[获取企业项目ID](https://support.huaweicloud.com/api-aom/aom_04_0024.html)。 - 查询单个企业项目下实例，填写企业项目id。 - 查询所有企业项目下实例，填写"all_granted_eps"。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | page_size | Integer | 当前页大小。 | | dashboards | Array of [Dashboard] objects | 仪表盘详情列表。 | 表5Dashboard | 参数 | 参数类型 | 描述 | |:---|:---|:---| | project_id | String | 项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-aom/aom_04_0024.html)。 | | dashboard_type | String | **参数解释：** 仪表盘类型。 **取值范围：** - dashboard：普通仪表盘 - ELB：elb云服务相关仪表盘 - VPC：vpc云服务相关仪表盘 | | dashboard_title | String | 仪表盘名称。 | | dashboard_title_en | String | 仪表盘英文名称。 | | dashboard_id | String | 仪表盘id。 | | version | String | 仪表盘版本。 | | enterprise_project_id | String | 仪表盘企业项目id。获取方式请参见：[获取企业项目ID](https://support.huaweicloud.com/api-aom/aom_04_0024.html)。 | | folder_name | String | 仪表盘分组名称。 | | folder_id | String | 仪表盘分组id。 | | sync_data | String | 待同步的仪表盘数。 | | is_create_action | Boolean | 是否创建 - false：更新 - true：创建 | | dashboard_tags | Array of Map\ objects | 仪表盘标签列表。 | | is_favorite | Boolean | 是否收藏 - true：收藏 - false：不收藏 | | created | Long | 仪表盘创建时间。 | | updated | Long | 仪表盘更新时间。 | | created_by | String | 创建仪表盘的账号名称。 | | updated_by | String | 更新仪表盘的账号名称。 | | charts | Array of objects | 仪表盘图表详情。 | | templating | Object | 仪表盘变量列表。 | | display | Boolean | 是否展示。 | | query_count | Integer | 查询总次数。 | | 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 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aom.v2.region.AomRegion; import com.huaweicloud.sdk.aom.v2.*; import com.huaweicloud.sdk.aom.v2.model.*; public class ListDashBoardsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("")) .build(); ListDashBoardsRequest request = new ListDashBoardsRequest(); try { ListDashBoardsResponse response = client.listDashBoards(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v2.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("")) \ .build() try: request = ListDashBoardsRequest() response = client.list_dash_boards(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := aom.AomClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := aom.NewAomClient(hcClient) request := &model.ListDashBoardsRequest{} response, err := client.ListDashBoards(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/AOM/sdk?api=ListDashBoards)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK 请求响应成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-aom/ErrorCode.html)。