Querying the Dashboard List
Function
This API is used to query the dashboard list.
Calling Method
For details, see Calling APIs.
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dashboard_type |
No |
String |
Dashboard type. |
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 |
String |
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 |
Dashboard type. |
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.
Enumeration values:
|
dashboard_tags |
Array of Map<String,String> objects |
Dashboard tag list. |
is_favorite |
Boolean |
Whether to add the dashboard to favorites.
Enumeration values:
|
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 |
String |
Display or not. |
query_count |
String |
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 }
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