接口功能介绍

该接口提供立即备份能力，将对所有绑定了此备份策略的云主机执行备份

准备工作 ：

构造请求：在调用前需要了解如何构造请求，详情查看构造请求

认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权

接口约束

1.使用限制，本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测

2.备份策略必须存在且处于启用或者停用状态；

3.备份策略需绑定存储库，且存储库处于可用状态，若过期或者容量小于0，存储库不可用；

4.备份策略需绑定云主机，且云主机处于可用状态，比如开机关机状态

URI

POST /v4/ecs/backup-policy/backup-instances

路径参数

无

Query参数

无

请求参数

请求头header参数

无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
regionID	是	String	资源池ID，您可以查看地域和可用区来了解资源池获取：`查`资源池列表查询	bb9fdb42056f11eda1610242ac110002
policyID	是	String	云主机备份策略ID，32字节获取：`查` 查询云主机备份策略列表 `创`创建云主机备份策略	a2e8c1368b3911ed915f0242ac11000c

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码(800为成功，900为失败)	800
errorCode	String	业务细分码，为product.module.code三段式码，详见错误码说明	Openapi.PatternCheck.NotValid
message	String	失败时的错误描述，一般为英文描述	SUCCESS
description	String	失败时的错误描述，一般为中文描述	成功
returnObj	Object	返回参数		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
policyID	String	云主机备份策略ID	c0f853a4a5c311edb27d0242ac110007

请求示例

示例：执行备份策略，将绑定了该备份策略的云主机立即进行备份
{
    "regionID":"bb9fdb42056f11eda1610242ac110002",
    "policyID":"a2e8c1368b3911ed915f0242ac11000c"
}

请求头header

无

请求体body

无

响应示例

{
    "returnObj": {
        "policyID":"a2e8c1368b3911ed915f0242ac11000c"
    },
    "message": "SUCCESS",
    "description": "成功", 
    "statusCode": 800
}

状态码

状态码	描述
200	表示请求成功。

错误码

errorCode	描述
Openapi.PatternCheck.NotValid	请求参数无效
EcsBackup.RegionInfo.Empty	查询资源池信息为空或资源池不存在，请确认资源池ID是否有效
EcsBackup.PolicyCheck.NotFound	备份策略未找到
EcsBackup.PolicyCheck.UnbindRepo	备份策略未绑定备份存储库
EcsBackup.PolicyCheck.UnbindEcs	备份策略未绑定云主机
EcsBackup.PolicyCheck.PolicyIdNotUUIDFormat	备份策略ID必须是UUID格式
EcsBackup.RepositoryCheck.PolicyNotValid	云主机备份策略状态无效
EcsBackup.RepositoryCheck.AccessFailed	查询云主机存储库失败
EcsBackup.RepositoryCheck.NotFound	存储库未找到
EcsBackup.RepositoryCheck.DataDamaged	存储库数据不符合预期
EcsBackup.RepositoryCheck.Expired	存储库已过期
EcsBackup.RepositoryCheck.SizeNull	存储库容量必须大于0
EcsBackup.PolicyCheck.InstanceStateNotValid	云主机必须处于运行中或关机状态
EcsBackup.Admin.AccessFailed	系统错误

云主机备份

执行备份策略