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

Querying Details About an EVS Disk Type

Function

This API is used to query details about an EVS disk type.

URI

  • URI format

    GET /v2/{project_id}/types/{type_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.

    type_id

    Yes

    Specifies the disk type ID.

Request

  • Example request
    GET https://{endpoint}/v2/{project_id}/types/6c81c680-df58-4512-81e7-ecf66d160638

Response

  • Parameter description

    Parameter

    Type

    Description

    volume_type

    Object

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

    error

    Object

    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

    Object

    Specifies the disk type specifications. For details, see Parameters in the extra_specs field.

    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

    The reserved field.

    is_public

    Boolean

    The reserved field.

  • Parameters in the extra_specs field

    Parameter

    Type

    Description

    volume_backend_name

    String

    The reserved field.

    availability-zone

    String

    The reserved field.

    HW:availability_zone

    String

    The reserved field.

    RESKEY:availability_zones

    String

    The AZs that support the current disk type.

    os-vendor-extended:sold_out_availability_zones

    String

    The AZs where the current disk type is sold out.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    String

    The error message returned if an error occurs.

    code

    String

    The error code returned if an error occurs.

    For details about the error code, see Error Codes.

  • Example response
    {
        "volume_type": {
            "extra_specs": {
                "volume_backend_name": "SAS", 
                "availability-zone": "az-dc-1"
            }, 
            "name": "SAS", 
            "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"
        }
    }

Status Codes

  • Normal

    200

Error Codes

For details, see Error Codes.