Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
30 KiB
Batch Deleting Resource Groups
Function
This API is used to delete resource groups in batches.
URI
POST /v2/{project_id}/resource-groups/batch-delete
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
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
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 |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
group_ids |
Yes |
Array of strings |
IDs of resource groups to be deleted in batches. Array length: 1 to 100 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
group_ids |
Array of strings |
IDs of resource groups that were deleted. Array length: 1 to 100 |
Status code: 400
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
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: 403
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
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
Batch deleting resource groups
{
"group_ids" : [ "rg1761380163308Dxxxxxxxx" ]
}
Example Responses
Status code: 200
IDs of resource groups that were deleted
{
"group_ids" : [ "rg1761380163308Dxxxxxxxx" ]
}
Status Codes
Status Code |
Description |
|---|---|
200 |
IDs of resource groups that were successfully deleted. |
400 |
Parameter verification failed. |
401 |
Authentication failed. |
403 |
Authentication failed. |
500 |
Failed to complete the request because of an internal server error. |
Error Codes
See Error Codes.