Help Center/ Cloud Eye/ API Reference/ API V2/ Dashboards/ This API is used to delete dashboards in batches.

Updated on 2024-12-26 GMT+08:00

View PDF

This API is used to delete dashboards in batches.

Function

Constraints

This API is not supported in the following five sites: CN East-Qingdao, LA-Mexico City1, TR-Istanbul, AP-Jakarta, and 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

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant ID. Minimum: 1 Maximum: 64

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	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	User token. It is a response to the API used to obtain 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 value. Minimum: 1 Maximum: 16000

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
dashboard_ids	No	Array of strings	Dashboard ID list. Array Length: 1 - 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 - 100

**Table 5** BatchDeleteDashboardRespInfo
Parameter	Type	Description
dashboard_id	String	Dashboard ID. Regex Pattern: ^db([a-z]\|[A-Z]\|[0-9]){22}
ret_status	String	Operation result. The value can be successful or error. Enumeration values: 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 codes 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 codes 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 codes 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.