Querying Summary Information of EVS Disks

Function

URI

• URI format

  GET /v3/{project_id}/volumes/summary

• Parameter description

  Parameter	Mandatory	Description
  project_id	Yes	The project ID.

Request

• Example request

  GET https://{endpoint}/v3/{project_id}/volumes/summary
  
  

Response

• Parameter description

  Parameter	Type	Description
  volume-summary	Object	The summary information of queried disks. For details, see Parameters in the volume-summary field.

• Parameters in the volume-summary field

  Parameter	Type	Description
  total_size	Integer	The total size of disks, in GB.
  total_count	Integer	The total quantity of disks.
  metadata	Object	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": {}
      }
  }
  
  

  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