Querying EVS Disks¶

Function¶

This API is used to query EVS disks.

URI¶

URI format
GET /v3/{project_id}/volumes
Parameter description
Parameter
Mandatory
Description
project_id
Yes
The project ID.
For details about how to obtain the project ID, see Obtaining a Project ID.

Parameter	Mandatory	Description
project_id	Yes	The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request filter parameters

Parameter	Type	Mandatory	Description
marker	String	No	The ID of the resource from which the pagination query starts. It is the ID of the last resource on the previous page.
name	String	No	The disk name. The value can contain a maximum of 255 bytes.
limit	Integer	No	The maximum number of query results that can be returned. The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit. If the tenant has more than 50 disks in total, you are advised to use this parameter and set its value to 50 to improve the query efficiency. Examples are provided as follows: GET /v3/xxx/volumes?limit=50: Queries the 1-50 disks. GET /v3/xxx/volumes?offset=50&limit=50: Queries the 51-100 disks.
sort_key	String	No	The keyword based on which the returned results are sorted. The value can be id, status, size, or created_at, and the default value is created_at.
sort_dir	String	No	The result sorting order. The default value is desc. desc: the descending order asc: the ascending order
offset	Integer	No	The query offset. All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks.
status	String	No	The disk status. For details, see EVS Disk Status.
metadata	String	No	The disk metadata.
availability_zone	String	No	The AZ information.

Request¶

The following example shows how to query the disks in the available state.

Example request

GET https://{endpoint}/v3/{project_id}/volumes?status=available

Response¶

Response parameters

Parameter	Type	Description
volumes	list	The list of queried disks. For details, see Parameters in the volumes field.
volumes_links	list	The query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query.
count	Object	The number of records returned in this query.
error	Object	The error message returned if an error occurs. For details, see Parameters in the error field.

Parameters in the volumes field
Parameter
Type
Description
id
String
The disk ID.
links
Array of objects
The disk URI. For details, see Parameters in the links field.
name
String
The disk name. The value can contain a maximum of 255 bytes.
Parameters in the links field
Parameter
Type
Description
href
String
The corresponding shortcut link.
rel
String
The shortcut link marker name.
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.

Parameter	Type	Description
id	String	The disk ID.
links	Array of objects	The disk URI. For details, see Parameters in the links field.
name	String	The disk name. The value can contain a maximum of 255 bytes.

Parameter	Type	Description
href	String	The corresponding shortcut link.
rel	String	The shortcut link marker name.

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

{

    "volumes": [
        {
            "id": "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
            "links": [
                {
                    "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
                    "rel": "self"
                },
                {
                    "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
                    "rel": "bookmark"
                }
            ],
            "name": "zjb_u25_test"
        },
        {
            "id": "2bce4552-9a7d-48fa-8484-abbbf64b206e",
            "links": [
                {
                    "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
                    "rel": "self"
                },
                {
                    "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
                    "rel": "bookmark"
                }
            ],
            "name": "zjb_u25_test"
        },
        {
            "id": "3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
            "links": [
                {
                    "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
                    "rel": "self"
                },
                {
                    "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
                    "rel": "bookmark"
                }
            ],
            "name": "zjb_u25_test"
        }
    ],
    "volumes_links": [
        {
            "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
            "rel": "next"
        }
    ]
}

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

last updated: 2024-11-08 14:12 UTC - commit: 50da2676988856820379788ad5f4675a0a4e9b06