Updated on 2025-08-27 GMT+08:00

Querying Dashboards

Function

This API is used to query dashboards.

Constraints

This API is not supported in the following regions: CN East-Qingdao, LA-Mexico City1, TR-Istanbul, AP-Jakarta, ME-Riyadh, and AP-Manila.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/dashboards

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Tenant ID.

Constraints:

None

Value range:

Project ID, used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters.

Default value:

None

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_id

No

String

Enterprise project ID.

Regex Pattern: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0|all_granted_eps)$

is_favorite

No

Boolean

Whether a dashboard in an enterprise project is added to favorites. The value can be true (added to favorites) and false (not added to favorites). If this parameter is specified, enterprise_id is mandatory.

dashboard_name

No

String

Dashboard name.

Regex Pattern: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

dashboard_id

No

String

Dashboard ID.

Regex Pattern: ^db([a-z]|[A-Z]|[0-9]){22}

dashboard_type

No

String

Monitoring dashboard type. monitor_dashboard indicates a default dashboard, and other indicates a custom dashboard.

Enumeration values:

  • monitor_dashboard

  • other

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Definition

User token.

Constraints:

None

Value range:

The value can contain 1 to 16,384 characters.

Default value:

None

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

dashboards

Array of DashBoardInfo objects

Dashboard list.

Table 5 DashBoardInfo

Parameter

Type

Description

dashboard_id

String

Dashboard ID.

Regex Pattern: ^db([a-z]|[A-Z]|[0-9]){22}

dashboard_name

String

Custom dashboard name.

Regex Pattern: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

enterprise_id

String

Enterprise project ID.

Regex Pattern: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

creator_name

String

Name of the user who created the dashboard.

Regex Pattern: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

create_time

Long

Dashboard creation time.

Value range:

1111111111111-9999999999999

widgets_num

Integer

Total number of graphs on the dashboard.

Value range:

0-50

namespace

String

Namespace.

Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$

sub_product

String

Sub-product ID.

dashboard_template_id

String

Dashboard template ID.

Regex Pattern: ^mb([a-z]|[A-Z]|[0-9]){22}

row_widget_num

Integer

How a graph is displayed. 0 indicates that you can customize top and left of the graph. 1 indicates one graph per row.

Value range:

0-3

Default value:

3

is_favorite

Boolean

Whether a dashboard is added to favorites. The value can be true or false.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "dashboards" : [ {
    "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
    "dashboard_name" : "dashboard_name",
    "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "creator_name" : "creator_name",
    "create_time" : 1111111111111,
    "row_widget_num" : 3,
    "is_favorite" : false
  } ]
}

Status Codes

Status Code

Description

200

OK

400

The server failed to process the request.

401

Token authentication is required.

500

Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.