Help Center/Distributed Message Service for RabbitMQ/API Reference/APIs V2 (Recommended)/Instance Management/Restoring Instances from the Recycle Bin
Updated on 2025-12-29 GMT+08:00
View PDF

Restoring Instances from the Recycle Bin

Function

This API is used to restore instances from the recycle bin.

Calling Method

For details, see Calling APIs.

URI

POST /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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instances

No

Array of strings

Definition

Instance list.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

results

Array of InstanceResumeResult objects

Definition

Instance restoration list.

Table 4 InstanceResumeResult

Parameter

Type

Description

instance_id

String

Definition

Instance ID.

Range

N/A

job_id

String

Definition

Task ID.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Requests

Instances restored

POST https://{endpoint}/v2/{project_id}/recycle

{
  "instances" : [ "9b6b7173-d1d8-4604-86a8-43b732715a03" ]
}

Example Responses

Status code: 200

Instances restored.

{
  "results" : [ {
    "instance_id" : "9b6b7173-d1d8-4604-86a8-43b732715a03",
    "job_id" : "8abfa7b39a91da03019a960bed49560e",
    "error_msg" : null
  } ]
}

Status Codes

Status Code

Description

200

Instances restored.

Error Codes

See Error Codes.

Parent Topic: Instance Management