Querying Instances in the Recycle Bin

Function

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

• Before calling an API, you need to understand the API in Authentication.
• 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. For details about how to obtain the project ID, 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
  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. 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.
  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.

• Example normal response
  RDS for MySQL response example

  {
   "total_count": 1,
    "instances": [
      {
        "id": "f55da7ba462f414da2f9505fda3562b9in01",
        "name": "mysql_57_ha_test3",
        "ha_mode": "Ha",
        "engine_name": "mysql",
        "engine_version": "5.7.44",
        "pay_model": "0",
        "created_at": "2025-09-02T09:04:06+0000",
        "deleted_at": "2025-09-03T10:06:33+0000",
        "volume_type": "SSD",
        "volume_size": 40,
        "data_vip": "172.168.235.59",
        "enterprise_project_id": "0",
        "retained_until": "2025-09-10T10:07:05+0000",
        "recycle_backup_id": "37a3d791431045a782d72496d384150abr01",
        "recycle_status": "COMPLETED",
        "recycle_backups": [
          {
            "backup_id": "37a3d791431045a782d72496d384150abr01",
            "backup_name": "mysql-f55da7ba462f414da2f9505fda3562b9in01-20250903100705426",
            "backup_status": "COMPLETED",
            "backup_create_at": "2025-09-03T10:07:05+0000",
            "backup_update_at": "2025-09-03T10:08:20+0000",
            "backup_size": 3600
          }
        ],
        "is_serverless": false
      }
    ]
  }

  RDS for PostgreSQL response example

  {
  	"total_count": 1,
  	"instances": [{
  		"id": "b0fd0c715ad043c98107ad12398653adin03",
  		"name": "rds-9111",
  		"ha_mode": "Single",
  		"engine_name": "postgresql",
  		"engine_version": "17.5",
  		"pay_model": "0",
  		"created_at": "2025-09-03T07:59:20+0000",
  		"deleted_at": "2025-09-03T08:24:18+0000",
  		"volume_type": "SSD",
  		"volume_size": 40,
  		"data_vip": "192.168.10.251",
  		"enterprise_project_id": "0",
  		"retained_until": "2025-09-10T08:20:20+0000",
  		"recycle_backup_id": "644b1a945db648868af8f54e04f5d6a6br03",
  		"recycle_status": "COMPLETED",
  		"recycle_backups": [{
  				"backup_id": "644b1a945db648868af8f54e04f5d6a6br03",
  				"backup_name": "postgresql-b0fd0c715ad043c98107ad12398653adin03-20250903082020735",
  				"backup_status": "COMPLETED",
  				"backup_create_at": "2025-09-03T08:20:20+0000",
  				"backup_update_at": "2025-09-03T08:21:27+0000",
  				"backup_size": 3629
  			},
  			{
  				"backup_id": "e225352d1f9b4c51aa170ea2c2fc4d4bbr03",
  				"backup_name": "postgresql-rds-9111-20250903075947338",
  				"backup_status": "COMPLETED",
  				"backup_create_at": "2025-09-03T07:59:47+0000",
  				"backup_update_at": "2025-09-03T08:00:57+0000",
  				"backup_size": 3633
  			}
  		],
  		"is_serverless": false
  	}]
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.