• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. API v2
  5. EVS Disk
  6. Querying EVS Disks (Deprecated)

Querying EVS Disks (Deprecated)

Function

This API is used to query EVS disks and display the query results in a list.

This API has been deprecated. Use another API. For details, see Querying EVS Disks.

URI

  • URI format

    GET /v2/{project_id}/cloudvolumes

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

  • Request filter parameters

    Parameter

    Type

    Mandatory

    Description

    marker

    string

    No

    Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one.

    name

    string

    No

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

    status

    string

    No

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

    limit

    int

    No

    Specifies the maximum number of query results that can be returned. The default value is 1000.

    availability_zone

    string

    No

    Specifies the AZ.

    sort_key

    string

    No

    Specifies the keyword based on which the returned results are sorted. The value can be idstatussize, or created_at, and the default value is created_at.

    sort_dir

    string

    No

    Specifies the result sorting order. The value can be desc (descending order) or asc (ascending order), and the default value is desc.

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    volumes

    list

    Specifies the list of queried EVS disks.

    id

    string

    Specifies the EVS disk UUID.

    links

    list<map<string, string>>

    Specifies the URI of the EVS disk.

    name

    string

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

    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.

  • Parameters in the links field

    Parameter

    Type

    Description

    href

    string

    Specifies the corresponding shortcut link.

    rel

    string

    Specifies the shortcut link marker name.

  • Example response
    {
        "volumes": [
            {
                "id": "e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", 
                "links": [
                    {
                        "href": "https://volume.az0.dc1.domainname.com/v2/cd631140887d4b6e9c786b67a6dd4c02/volumes/e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", 
                        "rel": "self"
                    }, 
                    {
                        "href": "https://volume.az0.dc1.domainname.com/cd631140887d4b6e9c786b67a6dd4c02/volumes/e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", 
                        "rel": "bookmark"
                    }
                ], 
                "name": "hallo5"
            }, 
            {
                "id": "4c5e8203-f70e-4717-90cd-4a8f636888d1", 
                "links": [
                    {
                        "href": "https://volume.az0.dc1.domainname.com/v2/cd631140887d4b6e9c786b67a6dd4c02/volumes/4c5e8203-f70e-4717-90cd-4a8f636888d1", 
                        "rel": "self"
                    }, 
                    {
                        "href": "https://volume.az0.dc1.domainname.com/cd631140887d4b6e9c786b67a6dd4c02/volumes/4c5e8203-f70e-4717-90cd-4a8f636888d1", 
                        "rel": "bookmark"
                    }
                ], 
                "name": "hallo4"
            }
        ]
    }

    or

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

Returned Values

  • Normal

    200

Error Codes

For details, see Error Codes.