Deleting a Workspace

Function

This API is used to delete a workspace.

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}

Table 1 describes the required parameters.
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

workspace_id

Yes

String

Workspace ID

Request Body

None

Response Body

Table 2 describes the response parameters.

Table 2 Parameter description

Parameter

Type

Description

error_msg

String

Error message of a failed API call.

This parameter is not included when the API call succeeds.

error_code

String

Error code of a failed API call. For details, see Error Code.

This parameter is not included when the API call succeeds.

request_id

String

request_id information of a failed API call.

This parameter is not included when the API call succeeds.

workspace_id

String

Workspace ID

Samples

  • Sample request
    DELETE https://{endpoint}/v1/{project_id}/workspaces/ccd05d1a553b4e188ea878e7dcb85e47
  • Successful sample response
    {
      "workspace_id": "ccd05d1a553b4e188ea878e7dcb85e47"
    }
  • Failed sample response
    {
      "error_msg": "workspace: ccd05d1a553b4e188ea878e7dcb85e47 not exist.",
      "error_code": "ModelArts.0104",
      "request_id": "3df6cb1559f74c48b97db739c716eae0"
    }

Status Code

For details about the status code, see Table 1.