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

Modifying a Dashboard

Function

This API is used to modify a dashboard.

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

    Write

    dashboard *

    g:EnterpriseProjectId

    -

    -

URI

PUT /v2/{project_id}/dashboards/{dashboard_id}

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

dashboard_id

Yes

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Definition

MIME type of the request body.

Constraints:

None

Value range:

The value can contain 1 to 64 characters.

Default value:

The default type is application/json; charset=UTF-8.

X-Auth-Token

No

String

Definition

User token.

Constraints:

None

Value range:

The value can contain 1 to 16,384 characters.

Default value:

None
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

dashboard_name

No

String

Definition

Custom dashboard name.

Constraints

N/A

Range

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

Default Value

N/A

is_favorite

No

Boolean

Definition

Whether the dashboard is added to favorites.

Constraints

N/A

Range

  • true: added to favorites.

  • false: not added to favorites.

Default Value

N/A

row_widget_num

No

Integer

Definition

How graphs are displayed.

Constraints

N/A

Range

  • 0: custom coordinates.

  • 1: one graph per row.

  • 2: two graphs per row.

  • 3: three graphs per row.

  • 4: four graphs per row.

Default Value

N/A

extend_info

No

ExtendInfo object

Definition

Extended information about the dashboard.

Constraints

N/A
Table 4 ExtendInfo

Parameter

Mandatory

Type

Description

filter

No

String

Definition

Metric aggregation method.

Constraints

N/A

Range

The value can be:

  • average

  • min: minimum value.

  • max: maximum value.

  • sum

Default Value

N/A

period

No

String

Definition

Metric aggregation period.

Constraints

N/A

Range

  • 1: original value.

  • 60: 1 minute.

  • 300: 5 minutes.

  • 1200: 20 minutes.

  • 3600: 1 hour.

  • 14400: 4 hours.

  • 86400: 1 day.

Default Value

N/A

display_time

No

Integer

Definition

Display time.

Constraints

N/A

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.

Default Value

N/A

refresh_time

No

Integer

Definition

Update time.

Constraints

N/A

Range

The value can be:

  • 0: no update.

  • 10: 10 seconds.

  • 60: 1 minute.

  • 300: 5 minutes.

  • 1200: 20 minutes.

Default Value

N/A

from

No

Long

Definition

Start time.

Constraints

N/A

Range

The timestamp value range is [0,9999999999999].

Default Value

N/A

to

No

Long

Definition

End time.

Constraints

N/A

Range

The timestamp value range is [0,9999999999999].

Default Value

N/A

screen_color

No

String

Definition

Background color of the dashboard.

Constraints

N/A

Range

100 characters.

Default Value

N/A

enable_screen_auto_play

No

Boolean

Definition

Whether the monitoring dashboard can be automatically switched.

Constraints

N/A

Range

  • true: automatically switched.

  • false: not automatically switched.

Default Value

N/A

time_interval

No

Integer

Definition

Automatic switchover interval of the dashboard.

Constraints

N/A

Range

Enumeration values:

  • 10000: 10 seconds.

  • 30000: 30 seconds.

  • 60000: 1 minute.

Default Value

N/A

enable_legend

No

Boolean

Definition

Whether to display the legend.

Constraints

N/A

Range

  • true: displayed.

  • false: not displayed.

Default Value

N/A

full_screen_widget_num

No

Integer

Definition

Number of graphs displayed on the dashboard.

Constraints

The value must be consistent with an available one on the console.

Range

[0,65535]

Default Value

N/A

Response Parameters

Status code: 204

No Content

Status code: 400

Table 5 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 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: 500

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.

Example Requests

{
  "dashboard_name" : "dashboard_name_new",
  "is_favorite" : true,
  "row_widget_num" : 0
}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

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