Querying the Dashboard List
Function
This API is used to query the dashboard list.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
aom:view:get
Read
-
-
-
-
URI
GET /v2/{project_id}/aom/dashboards
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. For details, see Obtaining a Token. |
|
Content-Type |
No |
String |
Message body type or format. Content type, which is application/json. |
|
Enterprise-Project-Id |
No |
String |
Enterprise project ID. For details, see Obtaining an Enterprise Project ID. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
page_size |
Integer |
Current page size. |
|
dashboards |
Array of Dashboard objects |
Dashboard details list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
project_id |
String |
Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID. |
|
dashboard_type |
String |
Definition Dashboard type. Range |
|
dashboard_title |
String |
Dashboard name. |
|
dashboard_title_en |
String |
Dashboard name. |
|
dashboard_id |
String |
Dashboard ID. |
|
version |
String |
Dashboard version. |
|
enterprise_project_id |
String |
ID of the enterprise project to which the dashboard belongs. For details, see Obtaining an Enterprise Project ID. |
|
folder_name |
String |
Dashboard group name. |
|
folder_id |
String |
Dashboard group ID. |
|
sync_data |
String |
Number of dashboards to be synchronized. |
|
is_create_action |
Boolean |
Whether to add a dashboard. |
|
dashboard_tags |
Array of Map<String,String> objects |
Dashboard tag list. |
|
is_favorite |
Boolean |
Whether to add the dashboard to favorites. |
|
created |
Long |
Time when the dashboard was created. |
|
updated |
Long |
Time when the dashboard was updated. |
|
created_by |
String |
Name of the account for adding the dashboard. |
|
updated_by |
String |
Name of the account for updating the dashboard. |
|
charts |
Object |
Dashboard graph details. |
|
templating |
Object |
List of dashboard variables. |
|
display |
Boolean |
Display or not. |
|
query_count |
Integer |
Total number of queries. |
|
time_range |
String |
Default time range for query. |
Example Requests
Query dashboard details.
https://{Endpoint}/v2/{project_id}/aom/dashboards
Example Responses
Status code: 200
OK: The request is successful.
{
"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 Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
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("<YOUR REGION>")) .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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# 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("<YOUR REGION>")) \ .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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListDashBoardsRequest{} response, err := client.ListDashBoards(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK: The request is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot