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 about how to obtain it, 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. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
results	Array of InstanceResumeResult objects	Definition Instance list. Constraints N/A Range N/A Default Value N/A

**Table 4** InstanceResumeResult
Parameter	Type	Description
instance_id	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
job_id	String	Definition Task ID. Constraints N/A Range N/A Default Value N/A
error_msg	String	Definition Error message. Constraints N/A Range N/A Default Value N/A

Example Requests

Instances restored from the recycle bin

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

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

Example Responses

Status code: 200

Instance restored from the recycle bin.

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