Help Center/ Elastic Volume Service/ API Reference/ API/ Recycle Bin Management/ Querying Details About All EVS Disks in the Recycle Bin

Updated on 2025-11-13 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Details About All EVS Disks in the Recycle Bin

Function

This API is used to query details about all EVS disks in the recycle bin.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/recycle-bin-volumes/detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition The project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition The disk name. You can call the Querying Details About All EVS Disks API to obtain the disk name. Constraints It can contain a maximum of 64 characters. Range N/A Default Value N/A
status	No	String	Definition The disk status. For details, see "EVS Disk Status". Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition The maximum number of query results that can be returned. Constraints N/A Range 1–1000 Default Value 1000
availability_zone	No	String	Definition The AZ information. You can call the Querying All AZs API or refer to Regions and Endpoints to obtain the AZ information. Constraints N/A Range N/A Default Value N/A
service_type	No	String	Definition The service type. Constraints N/A Range EVS DSS Default Value N/A
offset	No	Integer	Definition The offset in the pagination query. Constraints N/A Range The value is an integer greater than 0 but less than the total number of disks. Default Value 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Definition The total number of disks. Range N/A
volumes	Array of recycleBinVolume objects	Definition The disk list. Range N/A

**Table 5** recycleBinVolume
Parameter	Type	Description
id	String	Definition The disk ID. Range N/A
name	String	Definition The disk name. Range N/A
description	String	Definition The disk description. Range N/A
status	String	Definition The disk status. For details, see EVS Disk Status. Range N/A
attachments	Array of Attachment objects	Definition The disk attachment information. Range N/A
multiattach	String	Definition Whether the disk is shareable. Range true: shared disk false: non-shared disk
size	Integer	Definition The disk capacity, in GiB. Range N/A
metadata	Map<String,Object>	Definition The disk metadata information. Callers can add or remove the metadata information. Range The keys of this parameter used in EVS are described as follows: __system__cmkid The encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. For details about how to obtain the key ID, see Querying the Key List. __system__encrypted The encryption field in metadata. The value can be 0 (no encryption) or 1 (encryption). If this parameter is not specified, the encryption attribute of the disk is the same as that of the data source. If the disk is not created from a data source, the disk is not encrypted by default. hw:passthrough If this parameter value is true, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media and supports SCSI reservation commands. If this parameter value is false, the disk device type is VBD (default device type), which supports only simple SCSI read/write commands. If this parameter is not specified, the disk device type is VBD.
bootable	String	Definition Whether the disk is bootable. Range true: The disk is bootable. false: The disk is not bootable.
tags	Map<String,String>	Definition The disk tags. Range N/A
availability_zone	String	Definition The AZ to which the disk belongs. Range N/A
created_at	String	Definition The time when the disk was created. Range Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
service_type	String	Definition The service to which the disk belongs. Range EVS DSS
updated_at	String	Definition The time when the disk information was updated. Range Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
volume_type	String	Definition The disk type. Range The value can be SATA, SAS, GPSSD, SSD, ESSD, or GPSSD2. SATA: the common I/O type (end-of-sale) SAS: the high I/O type GPSSD: the general purpose SSD type SSD: the ultra-high I/O type ESSD: the extreme SSD type GPSSD2: the general purpose SSD V2 type
enterprise_project_id	String	Definition The enterprise project ID. Range N/A
plan_delete_at	String	Definition The time when a deleted disk will be permanently removed from the recycle bin. Range Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
pre_deleted_at	String	Definition The time when a disk was moved to the recycle bin. Range Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
dedicated_storage_id	String	Definition The ID of the dedicated storage pool housing the disk. Range N/A
dedicated_storage_name	String	Definition The name of the dedicated storage pool housing the disk. Range N/A
volume_image_metadata	String	Definition The metadata of the disk image. For details about the volume_image_metadata field, see Querying Image Details (Native OpenStack API). Range N/A
wwn	String	Definition The disk's unique identifier. Range N/A

**Table 6** Attachment
Parameter	Type	Description
attached_at	String	Definition The time when the disk was attached. Range Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
attachment_id	String	Definition The attachment ID. Range N/A
device	String	Definition The device name. Range N/A
host_name	String	Definition The name of the physical host housing the cloud server to which the disk is attached. Range N/A
id	String	Definition The ID of the attached disk. Range N/A
server_id	String	Definition The ID of the server to which the disk is attached. Range N/A
volume_id	String	Definition The disk ID. Range N/A

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error	Error object	Definition The error code returned if an error occurs. For details about the error code, see Error Codes. Range N/A

**Table 8** Error
Parameter	Type	Description
code	String	Definition The error code returned if an error occurs. Range For details about the error code, see Error Codes.
message	String	Definition The error message returned if an error occurs. Range N/A

Example Requests

GET https://evs.cn-north-1.myhuaweicloud.com/v3/490e121341fc481d95f946ef844cb06a/recycle-bin-volumes/detail

Example Responses

Status code: 200

{
  "count" : 1,
  "volumes" : [ {
    "id" : "0482c74b-1f85-4bc9-868c-64caecc16b61",
    "name" : "test",
    "status" : "restorable",
    "multiattach" : false,
    "size" : 89,
    "metadata" : { },
    "bootable" : "false",
    "tags" : { },
    "availability_zone" : "az1.dc1",
    "created_at" : "2018-12-11T07:25:15.531000",
    "volume_type" : "SATA",
    "volume_image_metadata" : { },
    "updated_at" : "2019-01-12T18:01:50.851000",
    "service_type" : "EVS",
    "enterprise_project_id" : "0",
    "plan_delete_at" : "2019-01-18T22:31:58.642000",
    "pre_deleted_at" : "2019-01-11T22:31:58.642000"
  } ]
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

Status Codes

Status Code	Description
200	OK
400	Bad Request

Error Codes

See Error Codes.

Parent topic: Recycle Bin Management

Previous topic: Recycle Bin Management

Next topic: Querying Details About an EVS Disk in the Recycle Bin

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot