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.

Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID.

Example request

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

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

{
    "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"
    }
}

For details, see Error Codes.

last updated: 2024-09-09 12:14 UTC - commit: 6113332414345505ad9f47066a06dbd285205999