Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Recycle Bin/ Querying All DB Engine Instances in the Recycle Bin

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

View PDF

Querying All DB Engine Instances in the Recycle Bin

Function

This API is used to query all DB engine instances in the recycle bin. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

GET /v3.1/{project_id}/recycle-instances

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_name	No	String	Definition DB instance name. Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Index offset. Constraints N/A Range 0–2,147,483,647 Default Value 0: The query starts from the first data record.
limit	No	Integer	Definition Number of records returned by a query. Constraints N/A Range 1–50 Default Value 50

Request Parameters

None

Response Parameters

**Table 2** Parameter description
Parameter	Type	Description
total_count	Integer	Definition Total number of records. Range N/A
instances	Array of objects	Definition Information about all instances in the recycle bin. 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 DB instance name. Range N/A
ha_mode	String	Definition Deployment model. Range Ha: centralized deployment Independent: independent deployment Combined: combined deployment
engine_name	String	Definition Engine name. Range N/A
engine_version	String	Definition Engine version. Range N/A
pay_model	String	Definition Billing mode. Range 0: pay-per-use 1: yearly/monthly
created_at	String	Definition Creation time in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is shown as +0800. Range N/A
deleted_at	String	Definition Deletion time in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is shown as +0800. Range N/A
volume_type	String	Definition Disk type. Range high: high I/O ultrahigh: ultra-high I/O essd: extreme SSD
volume_size	String	Definition Disk size. Range N/A
data_vip	String	Definition Private IP address. Range N/A
enterprise_project_id	String	Definition Enterprise project ID. The value 0 indicates the default enterprise project. Range N/A
enterprise_project_name	String	Definition Enterprise project name. Range N/A
backup_level	String	Definition Backup level. Range N/A
recycle_backup_id	String	Definition Backup ID. (Backup ID in the backup information generated when the instance is deleted.) Range N/A
recycle_status	String	Definition Backup status in the recycle bin. Range Running Active
mode	String	Definition Product type. Range basic: basic edition standard: standard edition enterprise: enterprise edition

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/619d3e78f61b4be68bc5aa0b59edcf7b/recycle-instances

Example Response

{ 
  "total_count" : 2, 
  "instances" : [ { 
    "id" : "21f20e55999947a9938ad0453b757e72in14", 
    "name" : "gaussdbv5_CCv20_bms_default_1_20220827012852", 
    "ha_mode" : "Ha", 
    "engine_name" : "gaussdbv5", 
    "engine_version" : "V2.0-2.3.0", 
    "pay_model" : 0, 
    "created_at" : "2022-08-09T09:26:44.000+08:00", 
    "deleted_at" : "2022-08-09T09:26:44.000+08:00", 
    "volume_type" : "localssd", 
    "volume_size" : "", 
    "data_vip" : "25.213.0.41 / 25.213.0.188 / 25.213.0.101 / 25.213.0.82", 
    "enterprise_project_id" : 0, 
    "enterprise_project_name" : null, 
    "backup_level" : null,
    "recycle_backup_id" : "00b755ed678e41d18c74b28e2ad41bdcbr14", 
    "recycle_status" : "Active", 
    "mode" : "enterprise"
  }, { 
    "id" : "a9df5b52b32e4571b1b6425a78a32956in14", 
    "name" : "ecs-lxy-backup-3", 
    "ha_mode" : "Ha", 
    "engine_name" : "gaussdbv5", 
    "engine_version" : "V2.0-2.3.0", 
    "pay_model" : 0, 
    "created_at" : "2022-08-09T09:26:44.000+08:00", 
    "deleted_at" : "2022-08-09T09:26:44.000+08:00", 
    "volume_type" : "ultrahigh", 
    "volume_size" : "", 
    "data_vip" : "173.202.10.246 / 173.202.10.205 / 173.202.10.175", 
    "enterprise_project_id" : 0, 
    "enterprise_project_name" : null, 
    "backup_level" : null, 
    "recycle_backup_id" : "ef393704ef0045d1b6226b6f2cdc48a7br14", 
    "recycle_status" : "Active", 
    "mode" : "enterprise"
  } ] 
}