Updated on 2025-12-29 GMT+08:00

Querying the Recycle Bin Instance List

Function

This API is used to query the recycle bin instance list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/recycle

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

retention_days

Integer

Definition

Retention days.

Range

1–7

default_use_recycle

Boolean

Definition

Whether to use the recycle bin.

Range

  • true: Yes

  • false: No

recycle_instances

Array of InstanceRecycleInfo objects

Definition

Recycled instance list.

Table 3 InstanceRecycleInfo

Parameter

Type

Description

instance_id

String

Definition

Instance ID.

Range

N/A

status

String

Definition

Instance status.

Range

For details, see Instance Status.

name

String

Definition

Instance name.

Range

N/A

engine

String

Definition

Message engine.

Range

  • rocketmq: RocketMQ message engine.

  • reliability: RocketMQ message engine alias.

in_recycle_time

String

Definition

Recycle time.

Range

N/A

save_time

Integer

Definition

Retention period.

Range

1–7

auto_delete_time

String

Definition

Automatic deletion time.

Range

N/A

cost_per_hour

Double

Definition

Hourly fee.

Range

N/A

error_message

String

Definition

Error message.

Range

N/A

product_id

String

Definition

Product ID.

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Recycle bin instance list queried.

{
  "retention_days" : 2,
  "default_use_recycle" : true,
  "recycle_instances" : [ {
    "instance_id" : "9b6b7173-d1d8-4604-86a8-43b732715a03",
    "status" : "ERROR",
    "name" : "rabbitmq_test",
    "engine" : "rabbitmq",
    "in_recycle_time" : 1763450761139,
    "save_time" : 2,
    "auto_delete_time" : 1763623561139,
    "cost_per_hour" : 0.0,
    "error_message" : null,
    "product_id" : "c6.4u8g.cluster"
  } ]
}

Status Codes

Status Code

Description

200

Recycle bin instance list queried.

Error Codes

See Error Codes.