文档首页/ CloudDevice 服务/ API参考/ API/ 实例使用/ 实例备份 - BatchBackupInstances
更新时间:2025-10-30 GMT+08:00

实例备份 - BatchBackupInstances

功能介绍

实例数据批量备份到OBS,然后释放物理实例。

调用此api的前提条件是实例数据已还原到物理机。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v1/instances/backup

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

租户的iam token信息

x-request-id

String

消息跟踪唯一id

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_ids

Array of strings

实例列表,单个实例最长32个字符,列表最长100列

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

error_code

String

响应码,错误码规范KooPhone.API.1001,数字递增

error_msg

String

响应描述

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

0:成功

KOOPHONE.API.0000:租户不存在

KOOPHONE.API.1000:请求参数错误

KOOPHONE.API.1001:没有实例权限

KOOPHONE.API.9999:服务内部错误

error_msg

String

错误信息

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_code

String

0:成功

KOOPHONE.API.0000:租户不存在

KOOPHONE.API.1000:请求参数错误

KOOPHONE.API.1001:没有实例权限

KOOPHONE.API.9999:服务内部错误

error_msg

String

错误信息

请求示例

/v1/instances/backup

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

响应示例

状态码:200

正常响应

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

状态码

状态码

描述

200

正常响应

400

请求错误

500

内部错误

错误码

请参见错误码