Help Center/ Cloud Eye/ API Reference/ API/ Cloud Resource Monitoring/ Dashboards/ Querying Dashboards
Updated on 2026-06-11 GMT+08:00
View PDF
Share

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.

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

    ces:dashboards:list

    List

    dashboard *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

GET /v2/{project_id}/dashboards

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It is 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 from the API or console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

1 to 64 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_id

No

String

Definition

Enterprise project ID.

Constraints

N/A

Range

The value allows 36 characters. It can only contain lowercase letters, digits, hyphens (-), and underscores (_). You can customize an enterprise project ID. The value can also be 0 (default enterprise project ID) or all_granted_eps (all enterprise project IDs).

Default Value

N/A

is_favorite

No

Boolean

Definition

Whether a dashboard in an enterprise project is added to favorites.

Constraints

If this parameter is specified, enterprise_id is mandatory.

Range

  • true: added to favorites

  • false: not added to favorites

Default Value

N/A

dashboard_name

No

String

Definition

Dashboard name.

Constraints

N/A

Range

The value allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

Default Value

N/A

dashboard_id

No

String

Definition

Dashboard ID.

Constraints

N/A

Range

The value starts with db and is followed by 22 characters of letters, digits, or a combination of both. The total length is 24 characters.

Default Value

N/A

dashboard_type

No

String

Definition

Dashboard type.

Constraints

N/A

Range

  • monitor_dashboard: dashboard

  • other: custom dashboard

Default Value

N/A

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

Definition

Dashboard list.
Table 5 DashBoardInfo

Parameter

Type

Description

dashboard_id

String

Definition

Dashboard ID.

Range

The value must start with db and is followed by 22 characters of letters, digits, or a combination of both. The total length is 24 characters.

dashboard_name

String

Definition

Custom dashboard name.

Range

The value allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

enterprise_id

String

Definition

Enterprise project ID.

Range

The value allows 36 characters. It can only contain lowercase letters, digits, hyphens (-), and underscores (_). You can customize an enterprise project ID. It can also be 0 (default enterprise project ID).

creator_name

String

Definition

Name of the user who created the dashboard.

Range

The value allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

create_time

Long

Definition

Dashboard creation time.

Range

1111111111111 to 9999999999999

widget_num

Integer

Definition

Total number of graphs on the dashboard.

Range

0 to 50.

extend_info

ExtendInfoResp object

Definition

Extended information about the dashboard.

namespace

String

Definition

Namespace of the service. For details, see Services Interconnected with Cloud Eye.

Range

The value is in the service.item format. The values of service and item must start with a letter and contain only letters, digits, and underscores (_). It can contain 3 to 32 characters.

sub_product

String

Definition

Sub-product ID.

Range

[1,128]

dashboard_template_id

String

Definition

Dashboard template ID.

Range

The value starts with mb and is followed by 22 characters of letters, digits, or a combination of both. The total length is 24 characters.

row_widget_num

Integer

Definition

Number of graphs per row.

Range

  • 0: custom coordinates.

  • 1: one graph per row.

  • 2: two graphs per row.

  • 3: three graphs per row.

  • 4: four graphs per row.

is_favorite

Boolean

Definition

Whether a dashboard is added to favorites.

Range

  • true: added to favorites

  • false: not added to favorites
Table 6 ExtendInfoResp

Parameter

Type

Description

filter

String

Definition

Metric aggregation method.

Range

The value can be:

  • average

  • min: minimum value.

  • max: maximum value.

  • sum

period

String

Definition

Metric aggregation period.

Range

  • 1: original value.

  • 60: 1 minute.

  • 300: 5 minutes.

  • 1200: 20 minutes.

  • 3600: 1 hour.

  • 14400: 4 hours.

  • 86400: 1 day.

display_time

Integer

Definition

Display time.

Range

The value can be:

  • 0: custom.

  • 5: 5 minutes.

  • 15: 15 minutes.

  • 30: 30 minutes.

  • 60: 1 hour.

  • 120: 2 hours.

  • 180: 3 hours.

  • 720: 12 hours.

  • 1440: 24 hours.

  • 10080: seven days.

  • 43200: 30 days.

refresh_time

Integer

Definition

Update time.

Range

The value can be:

  • 0: no update.

  • 10: 10 seconds.

  • 60: 1 minute.

  • 300: 5 minutes.

  • 1200: 20 minutes.

from

Long

Definition

Start time.

Range

The timestamp value range is [0,9999999999999].

to

Long

Definition

End time.

Range

The timestamp value range is [0,9999999999999].

screen_color

String

Definition

Background color of the dashboard.

Range

100 characters.

enable_screen_auto_play

Boolean

Definition

Whether the monitoring dashboard can be automatically switched.

Range

  • true: yes.

  • false: no.

time_interval

Integer

Definition

Automatic switchover interval of the dashboard.

Range

The value can be:

  • 10000: 10 seconds.

  • 30000: 30 seconds.

  • 60000: 1 minute.

enable_legend

Boolean

Definition

Whether to display the legend.

Range

  • true: yes.

  • false: no.

full_screen_widget_num

Integer

Definition

Number of graphs displayed on the dashboard.

Range

[0,65535]

Status code: 400

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: 401

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.

Status code: 500

Table 9 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

Query the dashboard named test1 with the ID dbtest123 and the monitor_dashboard type in the default enterprise project. This dashboard is marked as a favorite.

/v2/{project_id}/dashboards?enterprise_id=0&is_favorite=true&dashboard_name=test1&dashboard_id=dbtest123&dashboard_type=monitor_dashboard

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,
    "widget_num" : 1,
    "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.

Parent topic: Dashboards