• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Disk Actions
  6. Attaching an EVS Disk (Deprecated)

Attaching an EVS Disk (Deprecated)

Function

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

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

Constraints

Do not call this API to attach a disk. If you need to attach a disk, call the ECS Attach Volume API.

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 disk ID.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    os-attach

    map<string, string>

    Yes

    Specifies the disk attachment marker. For details, see Parameters in the os-attach field.

  • Parameters in the os-attach field

    Parameter

    Type

    Mandatory

    Description

    instance_uuid

    string

    Yes

    Specifies the UUID of the host to be attached to.

    mountpoint

    string

    Yes

    Specifies the device name.

    host_name

    string

    No

    Specifies the name of the host to be attached to. The value can contain a maximum of 255 bytes.

    mode

    string

    No

    Specifies the attachment mode. The value can be rw (read/write) or ro (read-only).

  • Example request
    {
        "os-attach": {
            "instance_uuid": "95D9EF50-507D-11E5-B970-0800200C9A66", 
            "mountpoint": "/dev/vdc"
        }
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    error

    string

    Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    string

    Specifies the error message returned when an error occurs.

    code

    string

    Specifies the error code returned 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.