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

Batch Deleting Dashboards

Function

This API is used to delete dashboards in batches.

URI

POST /v2/{project_id}/dashboards/batch-delete

**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_ids	No	Array of strings	Dashboard ID list. Array length: 1 to 30

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
dashboards	Array of BatchDeleteDashboardRespInfo objects	Response body for deleting dashboards in batches. Array length: 1 to 100

**Table 5** BatchDeleteDashboardRespInfo
Parameter	Type	Description
dashboard_id	String	Dashboard ID. Regular expression matching: ^db([a-z]\|[A-Z]\|[0-9]){22}
ret_status	String	Operation result. The value can be successful or error. The value can be: successful error
error_msg	String	Error message. Minimum: 0 Maximum: 128

Status code: 400

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

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

Status code: 500

**Table 8** 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_ids" : [ "dbxxxxxxxxxxxxxxxxxxxxxx", "dbXXXXXXXXXXXXXXXXXXXXXX" ]
}

Example Responses

Status code: 200

{
  "dashboards" : [ {
    "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
    "ret_status" : "successful"
  }, {
    "dashboard_id" : "dbXXXXXXXXXXXXXXXXXXXXXX",
    "ret_status" : "error",
    "error_msg" : "record not found"
  } ]
}

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

30 KiB Raw Blame History