Help Center/ KooPhone/ API Reference/ APIs/ Instance Usage/ Backing Up an Instance

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

View PDF

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.

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
koophone:cloudphoneResource:instanceBackup	Write	cloudphoneResource *	-	-	-

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.
data	data object	Result returned by a asynchronous task.

**Table 4** data
Parameter	Type	Description
task_id	String	Task ID.
cmd_jobs	Array of CmdJob objects	Response task list.

**Table 5** CmdJob
Parameter	Type	Description
instance_id	String	Instance list.
job_id	String	Asynchronization command task ID.

Status code: 400

**Table 6** 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 7** 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.

{
  "data" : {
    "task_id" : "RM_6837531fd3f54550927b930180a706bf",
    "cmd_jobs" : [ {
      "instance_id" : "a44uhlf7",
      "job_id" : "1564567b8bab40f34711234cb80d0123"
    }, {
      "instance_id" : "efjy72gs",
      "job_id" : "1564567b8bab40f34711234cb80d0456"
    } ]
  },
  "error_code" : "0",
  "error_msg" : "ok"
}