接口功能介绍

创建云硬盘备份。

当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。

接口约束

需要保证云硬盘备份存储库的剩余容量足够创建云硬盘备份。

URI

POST /v4/ebs-backup/create

请求参数

请求头header参数

无

请求体body参数

参数	是否必填	参数类型	说明	示例
volumeID	是	String	云硬盘ID	0c582801-6b20-4e3a-956a-f3afbb5e9725
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
description	否	String	云硬盘备份描述	test-bak's description
repositoryID	是	String	备份存储库ID	9915c3f4-8d78-445a-a1da-d8d9287d506b
name	是	String	备份名称	test-bak

响应参数

参数	是否必填	类型	描述	示例	下级对象
statusCode	是	Integer	返回状态码（800为成功，900为失败）	800
message	是	String	错误信息的英文描述	SUCCESS
description	是	String	错误信息的本地化描述（中文）	成功
returnObj	否	Object	成功时返回对象		returnObj
errorCode	否	String	业务错误细分码，发生错误时返回	参考错误码

表 returnObj

参数名	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
backupID	是	String	云硬盘备份ID	59093d15-8a3c-53b9-b61b-484af10a3e97
backupName	是	String	云硬盘备份名称	test-bak
status	是	String	云硬盘备份状态，available-可用， error-失败，creating-创建中	available
size	是	Integer	云硬盘大小，单位GB	100
usedSize	是	Integer	云硬盘备份大小，单位Byte	1024000
description	是	String	云硬盘备份描述	test-bak's description
repositoryID	是	String	备份存储库ID	9915c3f4-8d78-445a-a1da-d8d9287d506b
repositoryName	是	String	备份存储库名称	test-repo
createdDate	是	Integer	创建时间	1663136607
updatedDate	是	Integer	更新时间	1663136607
finishDate	是	Integer	备份完成时间	1663136607
restoreDate	是	Integer	使用该云硬盘备份恢复数据时间	1663136607
restoreFinishDate	是	Integer	使用该云硬盘备份恢复完成时间	1663136607
freeze	是	Boolean	是否冻结	false
volumeID	是	String	云硬盘ID	0c582801-6b20-4e3a-956a-f3afbb5e9725
volumeName	是	String	云硬盘名称	test-vol
encrypted	是	Boolean	云硬盘是否加密	false
cmkUUID	是	String	云硬盘加密密钥UUID
volumeType	是	String	云硬盘类型	SATA
azName	是	String	可用域	az2
pass	是	Boolean	是否支持PASS	false
vMID	是	String	挂载的云主机ID	f2338f53-81b1-4fef-72cc-9f72b5fe705c
vMName	是	String	挂载的云主机名称	test-vm
projectID	是	String	企业项目ID	0

请求示例

请求头header

无

请求体body

{
    "regionID": "81f7728662dd11ec810800155d307d5b",
    "volumeID": "0c582801-6b20-4e3a-956a-f3afbb5e9725",
    "description": "test-bak's description",
    "repositoryID": "9915c3f4-8d78-445a-a1da-d8d9287d506b",
    "name": "test-bak"
}

响应示例

{
    "returnObj": {
        "cmkUUID": null,
        "volumeName": "test-vol-002",
        "usedSize": 0,
        "repositoryID": "9915c3f4-8d78-445a-a1da-d8d9287d506b",
        "pass": false,
        "size": 0,
        "regionID": "73f321ea-62ff-11ec-a8bc-005056898fe0",
        "encrypted": false,
        "repositoryName": "test-repository001",
        "restoreDate": null,
        "status": "creating",
        "description": "test-bak's description",
        "vMID": "",
        "azName": null,
        "createdDate": 1668033616,
        "freeze": false,
        "backupName": "test-bak",
        "restoreFinishDate": null,
        "volumeType": "SATA",
        "volumeID": "0c582801-6b20-4e3a-956a-f3afbb5e9725",
        "updatedDate": 1668062416,
        "finishDate": null,
        "backupID": "f7454119-867e-4317-b253-3ad47e35fcda",
        "vMName": "",
        "projectID": "0"
    },
    "message": "SUCCESS",
    "description": "成功",
    "statusCode": 800
}

错误码

errorCode	描述
EbsBackup.RegionInfo.Empty	查询资源池信息为空或资源池不存在，请确认资源池ID是否有效
EbsBackup.RegionInfo.AccessFailed	查询资源池失败，请重试。如果多次尝试失败，请提交工单
EbsBackup.RegionInfo.DataDamaged	查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单
EbsBackup.BackupInfo.EmptyName	云硬盘备份未指定名称
EbsBackup.RepositoryInfo.DataDamaged	云硬盘备份存储库数据不符合预期
EbsBackup.RepositoryInfo.NotFound	云硬盘备份存储库未找到
EbsBackup.RepositoryInfo.Empty	云硬盘备份存储库为空
EbsBackup.RepositoryInfo.AccessFailed	查询云硬盘备份存储库失败
EbsBackup.RepositoryInfo.Expired	云硬盘备份存储库过期
EbsBackup.DiskInfo.NotFound	云硬盘未找到
EbsBackup.DiskInfo.Empty	云硬盘信息为空
EbsBackup.DiskInfo.InvalidState	云硬盘当前状态，云硬盘备份不能进行该操作
EbsBackup.Parameter.InvalidRegionID	请求参数错误：{错误原因}

云硬盘备份

创建备份