Help Center/ Cloud Eye/ API Reference/ API v2/ Resource Groups/ Batch Deleting Resource Groups

Updated on 2024-05-16 GMT+08:00

View PDF

Batch Deleting Resource Groups

This API is used to batch delete resource groups.

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

POST /v2/{project_id}/resource-groups/batch-delete

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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the tenant token. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
group_ids	Yes	Array of strings	Specifies IDs of resource groups to be deleted in batches. Array Length: 1 - 100

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
group_ids	Array of strings	Specifies IDs of resource groups that were successfully deleted. Array Length: 1 - 100

Status code: 400

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

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

Status code: 403

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

Batch deleting resource groups

{
  "group_ids" : [ "rg0123456789xxxx" ]
}

Status code: 200

Specifies IDs of resource groups that were successfully deleted.

{
  "group_ids" : [ "rg0123456789xxxx" ]
}

Status Code	Description
200	Specifies IDs of resource groups that were successfully deleted.
400	Failed to verify parameters.
401	Not authenticated.
403	Authentication failed.
500	Internal system error.