Help Center/ Cloud Eye/ API Reference/ API v2/ Dashboards/ Modifying a Dashboard
Updated on 2024-05-16 GMT+08:00
View PDF
Share

Modifying a Dashboard

Function

This API is used to modify a dashboard.

Constraints

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

Debugging

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the tenant ID.

Minimum: 1

Maximum: 64

Regex Pattern: ^[a-zA-Z0-9-]{1,64}$

dashboard_id

Yes

String

Specifies the dashboard ID, which starts with db and followed by 22 letters and digits. Example: db16564943172807wjOmoLyn

Array Length: 24 - 24

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Specifies the MIME type of the request body. Default value application/json is recommended.

Default: application/json;charset=UTF-8

Minimum: 1

Maximum: 64

X-Auth-Token

Yes

String

Specifies the user token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token.

Minimum: 1

Maximum: 16000
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

dashboard_name

No

String

Specifies the name of the custom dashboard.

Minimum: 1

Maximum: 128

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

is_favorite

No

Boolean

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

row_widget_num

Yes

Integer

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

Minimum: 0

Maximum: 3

Default: 3

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

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

Bad Request

401

Unauthorized

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Dashboards