• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Disk Actions
  6. Detaching an EVS Disk (Deprecated)

Detaching an EVS Disk (Deprecated)

Function

This API is only used to change the EVS disk status from in-use to available.

This API call exists for compatibility reasons only and is not meant to be used.

Constraints

Do not call this API to detach an EVS disk. If you need to detach an EVS disk, call the Detach Volume API of ECS.

URI

  • URI format

    POST /v2/{project_id}/volumes/{volume_id}/action

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    volume_id

    Yes

    Specifies the EVS disk ID.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    os-detach

    map<string, string>

    Yes

    Specifies to detach the disk.

  • Parameter in the os-detach field

    Parameter

    Type

    Mandatory

    Description

    attachment_id

    string

    No

    Specifies the attachment ID. If the disk has only one mount point, this parameter is optional. If it has multiple mount points, the parameter is optional.

  • Example request
    {
        "os-detach": {
            "attachment_id": "d8777f54-84cf-4809-a679-468ffed56cf1"
        }
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    message

    string

    Specifies the returned error message when an error occurs.

    code

    string

    Specifies the returned error code when 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"
        }
    }

Returned Values

  • Normal

    202

Error Codes

For details, see Error Codes.