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

30 KiB

Raw Blame History

Creating or Copying a Dashboard

Function

This API is used to create or copy a dashboard.

URI

POST /v2/{project_id}/dashboards

**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}$

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	Yes	String	Custom dashboard name. Minimum: 1 Maximum: 128 Regular expression matching: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
enterprise_id	No	String	Enterprise project ID. Regular expression matching: ^((([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)$
dashboard_id	No	String	Dashboard ID. If a dashboard ID is specified, the dashboard will be copied. Regular expression matching: ^db([a-z]\|[A-Z]\|[0-9]){22}
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: 0

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
dashboard_id	String	Dashboard ID. Regular expression matching: ^db([a-z]\|[A-Z]\|[0-9]){22}

Status code: 400

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

**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

Status code: 500

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

Create a dashboard.

{
  "dashboard_name" : "dashboard_name",
  "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "row_widget_num" : 3
}

Copy a dashboard.

{
  "dashboard_name" : "dashboard_name",
  "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
  "row_widget_num" : 3
}

Example Responses