Deleting a Workspace_Workspace Management_Manager API_API Reference

This API is used to delete a workspace.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

POST /v1/{project_id}/{instance_id}/workspaces/batch-delete

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.
instance_id	Yes	String	DataArts Studio instance ID. For details about how to obtain it, see Instance ID and Workspace ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when Token Authentication is used. You can obtain it from the X-Subject-Token header in the response of the "Obtaining a User Token" API provided by IAM.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
workspace_ids	Yes	Array of strings	List of workspace IDs to be deleted. For details about how to obtain them, see Instance ID and Workspace ID.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
message	String	Response message.
is_success	Boolean	Whether the operation is successful.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Returned error information.
error_code	String	Returned error code.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Returned error information.
error_code	String	Returned error code.

{
  "workspace_ids" : [ "dee0f3ba02d34ac9b5a5a80eb81a4536", "dee0f3ba02d34ac9b5a5a80eb81a0000" ]
}

Status code: 400

Bad request.

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

Status code: 500

Internal server error.

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

Status Code	Description
200	The workspace is deleted successfully.
400	Bad request.
500	Internal server error.

Deleting a Workspace