• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. OpenStack Cinder API v3
  5. EVS Disk
  6. Querying Summary Information of EVS Disks

Querying Summary Information of EVS Disks

Function

This API is used to query the summary information of EVS disks, including the disk quantity, total capacity, and metadata information.

NOTE:

The request version must be 3.12 or later.

URI

  • URI format

    GET /v3/{project_id}/volumes/summary

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    volume-summary

    map

    Specifies the summary of all the queried EVS disks.

    total_size

    int

    Specifies the total disk capacity.

    total_count

    int

    Specifies the disk quantity.

    metadata

    map

    Specifies the disk metadata information. This parameter is supported when the request version is 3.36 or later.

  • Example response
    {
        "volume-summary": {
            "total_size": 83, 
            "total_count": 8, 
            "metadata": {
                "__openstack_region_name": [
                    "az1.dc1"
                ], 
                "__system__az_pools_maintenance": [
                    "AZ2:0"
                ]
            }
        }
    }
    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.