• Workspace

workspace
  1. Help Center
  2. Workspace
  3. API Reference
  4. Workspace
  5. Canceling Workspace

Canceling Workspace

Function

This interface is used to cancel Workspace. Ensure that the desktop of the current user is deleted before you cancel Workspace. The desktop cannot be resumed after you cancel Workspace.

URI

  • URI format

    DELETE /v1.0/{project_id}/workspaces

  • URI parameter description

    Name

    Mandatory

    Type

    Description

    project_id

    Yes

    string

    Specifies the user ID.

Request

  • Request example
DELETE /v1.0/29dfe82ada564ac2b927e1ff036d9a9b/workspaces

Response

  • Description

    Name

    Type

    Description

    job_id

    string

    Specifies the job ID for canceling Workspace. Users can use this ID to query the job execution status.

  • Response example
    {
       "job_id": "0000000059071dbc01591661d3990019"
    }

Returned Values

  • Normal

    202

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The request syntax is incorrect and cannot be understood by the server.

    401 Unauthorized

    Authentication fails.

    403 Forbidden

    You are not authorized to perform the operation.

    404 Not Found

    The requested resource is not found.

    405 Method Not Allowed

    The method specified in the request is not allowed.

    500 Internal Server Error

    Internal service error. For details about error codes, see Error Code Description.

    503 Service Unavailable

    The service is unavailable.