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

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

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

instances

Array of InstanceResumeResult objects

Definition

Instance 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

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

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

Example Responses

Status code: 200

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

Status Codes

Status Code

Description

200

Instances restored.

Error Codes

See Error Codes.