Querying Instances in the Recycle Bin

Function

This API is used to query instances in the recycle bin.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

URI

URI format
GET /v3/{project_id}/recycle-instances?offset={offset}&limit={limit}

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
offset	Yes	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints N/A Range The value must be a non-negative number. Default Value N/A
limit	Yes	Definition Number of records on each page. Constraints N/A Range [1, 50] Default Value N/A

Request

Parameter description
None
URI example
GET https://rds.ap-southeast-1.myhuaweicloud.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/recycle-instances?offset=0&limit=10

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
total_count	Integer	Definition Number of data records in the recycle bin. Range N/A
instances	Array of objects	Definition Instance information. For details, see Table 3.

**Table 3** instances field data structure description
Parameter	Type	Description
id	String	Definition Instance ID. Range N/A
name	String	Definition Instance name. Range N/A
ha_mode	String	Definition Instance type. Range The value is case-insensitive. Single: single-node instance Ha: primary/standby instance
engine_name	String	Definition DB engine name. Range N/A
engine_version	String	Definition DB engine version. Range N/A
pay_model	String	Definition Billing mode. Range 0: pay-per-use billing 1: yearly/monthly billing
created_at	String	Definition Creation time. Range The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.
deleted_at	String	Definition Deletion time. Range The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.
volume_type	String	Definition Storage type. Range ULTRAHIGH: ultra-high I/O storage. ULTRAHIGHPRO: ultra-high I/O (advanced) storage. This storage type is supported only with ultra-high performance (advanced) instances (permission required). CLOUDSSD: cloud SSD storage. This storage type is supported only with general-purpose and dedicated instances. LOCALSSD: local SSD storage.
volume_size	Integer	Definition Storage space. Range 40–4000, in GB. The value must be a multiple of 10. If you want to create an instance with storage space up to 6,000 GB or scale the storage up to 10,000 GB, contact customer service to apply for required permissions. This parameter is invalid for read replicas. The storage space of a read replica is the same as that of the primary instance by default.
data_vip	String	Definition Floating IP address. Range N/A
data_vip_v6	String	Definition Private IPv6 address. Range N/A
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
retained_until	String	Definition Time until which the instance can be retained. Range The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.
recycle_backup_id	String	Definition Backup ID. Range N/A
recycle_status	String	Definition Backup status. Range BUILDING: The instance is being backed up and cannot be rebuilt. COMPLETED: The backup is complete and the instance can be rebuilt.
is_serverless	Boolean	Definition Instance type. Range true: serverless false: non-serverless

Example normal response

{
  "total_count" : 2, 
  "instances" : [ { 
    "id" : "b7dea08c0f0e4fed9f1951fff9013639in01", 
    "name" : "rds-8b86", 
    "ha_mode" : "Ha", 
    "engine_name" : "mysql", 
    "engine_version" : "5.7.38", 
    "pay_model" : "0", 
    "created_at" : "2022-12-26T03:38:10+0000", 
    "deleted_at" : "2023-01-09T08:57:10+0000", 
    "volume_type" : "SSD", 
    "volume_size" : 80, 
    "data_vip" : "192.168.226.188", 
    "enterprise_project_id" : "0", 
    "retained_until" : "2023-01-16T09:20:48+0000", 
    "recycle_backup_id" : "e8e3c329c20442f5aec21b95a8cdaa52br01", 
    "recycle_status" : "COMPLETED",
    "is_serverless" : false
  }, { 
    "id" : "cc6d0dff4a9145d0a1335c35a866de23in01", 
    "name" : "rds-82b2", 
    "ha_mode" : "Ha", 
    "engine_name" : "mysql", 
    "engine_version" : "5.7.38", 
    "pay_model" : "0", 
    "created_at" : "2022-12-26T06:17:58+0000", 
    "deleted_at" : "2023-01-09T08:56:49+0000", 
    "volume_type" : "SSD", 
    "volume_size" : 200, 
    "data_vip" : "192.168.2.24", 
    "enterprise_project_id" : "0", 
    "retained_until" : "2023-01-16T09:20:45+0000", 
    "recycle_backup_id" : "3f35a348ae0943979bd302a9788f49e7br01", 
    "recycle_status" : "COMPLETED",
    "is_serverless" : false
  } ] 
}