Files

qiujiandong1 e9265fb6b0 CES API Update -20250521 version

Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>

2025-12-05 10:48:24 +00:00

27 KiB

Raw Blame History

Modifying a Dashboard

Function

This API is used to modify a dashboard.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Minimum: 1 Maximum: 64 Regular expression matching: ^[a-zA-Z0-9-]{1,64}$
dashboard_id	Yes	String	Dashboard ID, which starts with db and is followed by 22 characters of letters, digits, or a combination of both. Example: db16564943172807wjOmoLyn. The value can contain a maximum of 24 characters. Regular expression matching: ^db([a-z]\|[A-Z]\|[0-9]){22}$

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. application/json is recommended. Default value: application/json; charset=UTF-8 Minimum: 1 Maximum: 64
X-Auth-Token	Yes	String	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. After a response is returned, the value of X-Subject-Token in the response header is the token. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
dashboard_name	No	String	Custom dashboard name. Minimum: 1 Maximum: 128 Regular expression matching: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
is_favorite	No	Boolean	Whether a dashboard is added to favorites. The value can be true or false.
row_widget_num	No	Integer	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	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	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	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

27 KiB Raw Blame History