• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Disk
  6. Querying EVS Disk Types

Querying EVS Disk Types

Function

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

URI

  • URI format

    GET /v2/{project_id}/types

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    volume_types

    list

    Specifies the list of queried EVS disk types.

    extra_specs

    map<string, string>

    Specifies the specifications of the EVS disk type.

    volume_backend_name

    string

    Specifies the name of the EVS disk type.

    availability-zone

    string

    Specifies the AZ.

    name

    string

    Specifies the name of the EVS disk type.

    id

    string

    Specifies the ID of the EVS disk type.

    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 code, see the following returned values.

    description

    string

    Specifies the description of the EVS disk type.

    qos_specs_id

    string

    Specifies the Quality of Service (QoS) ID of the EVS disk type.

    is_public

    boolean

    Specifies whether the EVS disk type is public.

  • Example response
    {
        "volume_types": [
            {
                "extra_specs": {
                    "volume_backend_name": "SAS", 
                    "availability-zone": "az1.dc1"
                }, 
                "name": "SAS", 
                "qos_specs_id": null, 
                "id": "6c81c680-df58-4512-81e7-ecf66d160638", 
                "is_public": true, 
                "description": null
            }, 
            {
                "extra_specs": {
                    "volume_backend_name": "SATA", 
                    "availability-zone": "az1.dc1"
                }, 
                "name": "SATA", 
                "qos_specs_id": "585f29d6-7147-42e7-bfb8-ca214f640f6f", 
                "is_public": true, 
                "id": "ea6e3c13-aac5-46e0-b280-745ed272e662", 
                "description": null
            }, 
            {
                "extra_specs": {
                    "volume_backend_name": "SSD", 
                    "availability-zone": "az1.dc1"
                }, 
                "name": "SSD", 
                "qos_specs_id": "39b0c29a-308b-4f86-b478-5d3d02a43837", 
                "is_public": true, 
                "id": "6f2dee9e-82f0-4be3-ad89-bae605a3d24f", 
                "description": null
            }
        ]
    }

    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.