Help Center/ CloudDevice/ API Reference/ APIs/ Instance Usage/ Backing Up an Instance
Updated on 2025-10-30 GMT+08:00
View PDF
Share

Backing Up an Instance

Function

Back up instance data to OBS in batches and release physical instances.

The prerequisite for calling this API is that the instance data has been restored to the physical machine.

URI

POST /v1/instances/backup

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

IAM token information of the tenant.

x-request-id

Yes

String

Unique ID of a request.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instance_ids

Yes

Array of strings

Instance list. A single instance can contain a maximum of 32 characters, and the list can contain a maximum of 100 columns.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Response code. The error code specification is KooPhone.API.1001, and the number increases in ascending order.

error_msg

String

Error description.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

0: successful.

KOOPHONE.API.0000: The tenant does not exist.

KOOPHONE.API.1000: The request parameter is incorrect.

KOOPHONE.API.1001: Insufficient instance permissions.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

0: successful.

KOOPHONE.API.0000: The tenant does not exist.

KOOPHONE.API.1000: The request parameter is incorrect.

KOOPHONE.API.1001: Insufficient instance permissions.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error message.

Example Requests

/v1/instances/backup

{
  "user_id" : "1008600000104285462",
  "instance_id" : "iRJEVP9"
}

Example Responses

Status code: 200

Normal response.

{
  "error_code" : "0",
  "error_msg" : "OK"
}

Status Codes

Status Code

Description

200

Normal response.

400

Request error.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Instance Usage