• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Disk
  6. Querying Details About a Disk Type

Querying Details About a Disk Type

Function

This API is used to query details about a disk type.

URI

  • URI format

    GET /v2/{project_id}/types/{type_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    type_id

    Yes

    Specifies the disk type ID.

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    volume_type

    map

    Specifies the details of queried disk types. For details, see Parameters in the volume_type field.

    error

    string

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

  • Parameters in the volume_type field

    Parameter

    Type

    Description

    extra_specs

    map<string, string>

    Specifies the specifications of the disk type.

    volume_backend_name

    string

    Specifies the name of the disk type in Cinder.

    availability-zone

    string

    Specifies the AZ.

    name

    string

    Specifies the name of the disk type.

    id

    string

    Specifies the ID of the disk type.

    description

    string

    Specifies the description of the disk type.

    qos_specs_id

    string

    Specifies the QoS ID of the disk type.

    is_public

    boolean

    Specifies whether the disk type is public.

  • 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_type": {
            "extra_specs": {
                "volume_backend_name": "SATA", 
                "availability-zone": "az1.dc1"
            }, 
            "name": "SATA", 
            "qos_specs_id": null, 
            "is_public": true, 
            "id": "ea6e3c13-aac5-46e0-b280-745ed272e662", 
            "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.