• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Disk
  6. Updating an EVS Disk

Updating an EVS Disk

Function

This API is used to update the EVS disk information.

URI

  • URI format

    PUT /v2/{project_id}/volumes/{volume_id}

  • 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

    volume

    map<string, string>

    Yes

    Specifies the information of the disk to be updated. For details, see Parameters in the volume field.

  • Parameters in the volume field

    Parameter

    Type

    Mandatory

    Description

    name

    string

    No

    Specifies the disk name. The value can contain a maximum of 255 bytes.

    description

    string

    No

    Specifies the disk description. The value can contain a maximum of 255 bytes.

    metadata

    map<string,string>

    No

    Specifies the disk metadata.

    The length of the key or value in the metadata cannot exceed 255 bytes.

    display_name

    string

    No

    Specifies also the disk name. You can specify either parameter name or display_name. If both parameters are specified, the name value is used. The value can contain a maximum of 255 bytes.

    display_description

    string

    No

    Specifies also the disk description. You can specify either parameter description or display_description. If both parameters are specified, the description value is used. The value can contain a maximum of 255 bytes.

  • Example request
    {
        "volume": {
            "name": "test_volume", 
            "description": "test"
        }
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    volume

    map<string, string>

    Specifies the information of the updated disk. For details, see Parameters in the volumes field.

    error

    string

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

  • Parameters in the volumes field

    Parameter

    Type

    Description

    id

    string

    Specifies the disk ID.

    links

    list<map<string,string>>

    Specifies the disk URI. For details, see Parameters in the links field.

    name

    string

    Specifies the disk name.

    status

    string

    Specifies the disk status. For details, see EVS Disk Status.

    attachments

    array

    Specifies the disk attachment information. For details, see Parameters in the attachments field.

    availability_zone

    string

    Specifies the AZ to which the disk belongs.

    bootable

    string

    Specifies whether the disk is bootable.

    encrypted

    Boolean

    Specifies whether the disk is encrypted.

    created_at

    string

    Specifies the time when the disk was created.

    Time format: UTC YYYY-MM-DDTHH:MM:SS

    description

    string

    Specifies the disk description.

    volume_type

    string

    Specifies the disk type.

    replication_status

    string

    Specifies the disk replication status.

    consistencygroup_id

    string

    Specifies the ID of the consistency group where the disk belongs.

    source_volid

    string

    Specifies the source disk ID.

    snapshot_id

    string

    Specifies the snapshot ID.

    metadata

    map<string, string>

    Specifies the disk metadata. For details, see Parameters in the metadata field.

    size

    int

    Specifies the disk size, in GB.

    user_id

    string

    Reserved field

    updated_at

    string

    Specifies the time when the disk was updated.

    Time format: UTC YYYY-MM-DDTHH:MM:SS

    shareable

    Boolean

    Specifies whether the disk is shareable.

    NOTE:

    This field is no longer used. Use multiattach.

    multiattach

    Boolean

    Specifies whether the disk is shareable.

  • Parameters in the links field

    Parameter

    Type

    Description

    href

    string

    Specifies the corresponding shortcut link.

    rel

    string

    Specifies the shortcut link marker name.

  • Parameters in the attachments field

    Parameter

    Type

    Description

    server_id

    string

    Specifies the ID of the server to which the disk is attached.

    attachment_id

    string

    Specifies the ID of the attachment information.

    attached_at

    string

    Specifies the time when the disk was attached.

    Time format: UTC YYYY-MM-DDTHH:MM:SS

    host_name

    string

    Specifies the name of the physical host accommodating the server to which the disk is attached.

    volume_id

    string

    Specifies the disk ID.

    device

    string

    Specifies the device name.

    id

    string

    Specifies the ID of the attached resource.

  • Parameters in the metadata field

    Parameter

    Type

    Description

    __system__encrypted

    string

    Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1.
    • 0: indicates the disk is not encrypted.
    • 1: indicates the disk is encrypted.
    • If this parameter does not appear, the disk is not encrypted by default.

    __system__cmkid

    string

    Specifies the parameter that describes the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes.

    hw:passthrough

    string

    Specifies the parameter that describes the disk device type in metadata. The value can be true or false.
    • If this parameter is set to true, the disk device type is SCSI, that is, Small Computer System Interface (SCSI), which allows ECS OSs to directly access the underlying storage media and supports SCSI reservation commands.
    • If this parameter is set to false, the disk device type is VBD (the default type), that is, Virtual Block Device (VBD), which supports only simple SCSI read/write commands.
    • If this parameter does not appear, the disk device type is VBD.

    full_clone

    string

    Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method.

    readonly

    string

    Specifies whether the disk is read-only or read/write. The value can be True or False.
    • True: indicates that the disk is read-only.
    • False: indicates that the disk is read/write.

    attached_mode

    string

    Specifies whether the disk is attached as read-only or read/write. This parameter appears only when the disk has been attached to a server. The value can be ro or rw.
    • ro: indicates the disk is attached as read-only.
    • rw: indicates the disk is attached as read/write.

    policy

    string

    Specifies the backup policy ID in the metadata 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
    {
        "volume": {
            "attachments": [ ], 
            "availability_zone": "xxx", 
            "bootable": "false", 
            "consistencygroup_id": null, 
            "created_at": "2016-05-25T02:38:40.392463", 
            "description": "create for api test", 
            "encrypted": false, 
            "id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66", 
            "links": [
                {
                    "href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", 
                    "rel": "self"
                }, 
                {
                    "href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", 
                    "rel": "bookmark"
                }
            ], 
            "metadata": {
                "volume_owner": "openapi"
            }, 
            "name": "openapi_vol01", 
            "replication_status": "disabled", 
            "multiattach": false, 
            "size": 40, 
            "snapshot_id": null, 
            "source_volid": null, 
            "status": "creating", 
            "updated_at": null, 
            "user_id": "39f6696ae23740708d0f358a253c2637", 
            "volume_type": "SATA"
        }
    }

    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:

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

Returned Values

  • Normal

    200

Error Codes

For details, see Error Codes.