Updated on 2024-03-26 GMT+08:00

Deleting an EVS Disk

Function

This API is used to delete an EVS disk.

URI

  • URI format

    DELETE /v3/{project_id}/volumes/{volume_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

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

    volume_id

    Yes

    Specifies the disk ID.

  • Request filter parameters

    Parameter

    Type

    Mandatory

    Description

    cascade

    Boolean

    No

    Specifies to delete all snapshots associated with the disk. The default value is false.

Request

The following example shows how to delete a disk and all its snapshots.

  • Example request
    DELETE https://{endpoint}/v3/{project_id}/volumes/{volume_id}?cascade=true

Response

  • Response parameters

    Parameter

    Type

    Description

    error

    Object

    The error message returned if an error occurs. For details, see Parameters in the error field.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    String

    The error message returned if an error occurs.

    code

    String

    The error code returned if an error occurs.

    For details about the error code, see Error Codes.

  • Example response

    None

    or

    {
        "error": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

    In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:

    {
        "itemNotFound": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

Status Codes

  • Normal

    202

Error Codes

For details, see Error Codes.