Updated on 2022-02-22 GMT+08:00

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.

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

    volume_id

    Yes

    Specifies the disk ID.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    volume

    Object

    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

    Object

    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

    Object

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

    error

    Object

    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

    list

    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.
    • true: specifies a bootable disk.
    • false: specifies a non-bootable disk.

    encrypted

    Boolean

    Currently, this field is not supported by EVS.

    created_at

    String

    Specifies the time when the disk was created.

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

    description

    String

    Specifies the disk description.

    volume_type

    String

    Specifies the disk type.

    Currently, only SSD and SAS are supported.
    • SSD: specifies the ultra-high I/O disk type.
    • SAS: specifies the high I/O disk type.

    replication_status

    String

    Reserved field

    consistencygroup_id

    String

    Reserved field

    source_volid

    String

    Specifies the source disk ID.

    Currently, this field is not supported by EVS.

    snapshot_id

    String

    Specifies the snapshot ID.

    metadata

    Object

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

    size

    Integer

    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.XXXXXX

    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.
    • true: specifies a shared disk.
    • false: specifies a non-shared disk.

    storage_cluster_id

    String

    This is a reserved attribute.

  • 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.XXXXXX

    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

    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.

  • 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": "az-dc-1", 
            "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"
        }
    }

Status Codes

  • Normal

    200

Error Codes

For details, see Error Codes.