接口功能介绍

查询云硬盘备份列表。

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

接口约束

无

URI

GET /v4/ebs-backup/list

路径参数

无

Query参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
volumeID	否	String	云硬盘ID	0c582801-6b20-4e3a-956a-f3afbb5e9725
volumeName	否	String	云硬盘名称，模糊过滤	test-vol
backupName	否	String	云硬盘备份名称，模糊过滤	test-bak
repositoryID	否	String	云硬盘备份存储库ID	9915c3f4-8d78-445a-a1da-d8d9287d506b
status	否	String	云硬盘备份状态，available-可用， error-失败，restoring-恢复中，creating-创建中等	available
queryContent	否	String	该参数，可用于模糊过滤云硬盘ID/云硬盘名称/备份ID/备份名称，即上述4个字段如果包含该参数的值，则会被过滤出来	bak
pageNo	否	Integer	页码，默认1	1
pageSize	否	Integer	每页记录数目 ,默认10	10
projectID	否	String	企业项目ID，默认“0”	0

请求参数

请求头header参数

无

请求体body参数

无

响应参数

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

表 returnObj

参数名	是否必填	参数类型	说明	示例	下级对象
backupList	是	Array	云硬盘备份列表		backupList
totalCount	是	Integer	云硬盘备份总数	11
currentCount	是	Integer	当前页云硬盘备份数	10

表 backupList

参数名	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID	81f7728662dd11ec810800155d307d5b
backupID	是	String	云硬盘备份ID	59093d15-8a3c-53b9-b61b-484af10a3e97
backupName	是	String	云硬盘备份名称	test-bak
status	是	String	云硬盘备份状态，available-可用， error-失败，restoring-恢复中，creating-创建中，deleting-删除中等	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
paas	是	Boolean	是否支持PAAS	false
vMID	是	String	挂载的云主机ID	f2338f53-81b1-4fef-72cc-9f72b5fe705c
vMName	是	String	挂载的云主机名称	test-vm
projectID	是	String	企业项目ID	0

请求示例

请求头header

无

请求体body

无

响应示例

{
    "returnObj": {
        "totalCount": 3,
        "currentCount": 1,
        "backupList": [{
            "cmkUUID": null,
            "volumeName": "vm1-az2-3157-volume",
            "usedSize": 837772499,
            "repositoryID": "2e2f1de4-1ff8-4898-8bac-58fc39078b87",
            "vMName": "",
            "size": 40, 
            "regionID": "81f7728662dd11ec810800155d307d5b",
            "encrypted": false, 
            "repositoryName": "test-bak-repo", 
            "restoreDate": null,
            "status": "available", 
            "description": "",
            "vMID": "",
            "azName": null,
            "createdDate": 1675972802,
            "freeze": false,
            "paas": false,
            "backupName": "autobk-fqi1-0001",
            "restoreFinishDate": null, 
            "volumeType": "SATA", 
            "volumeID": "d75fdd79-5b67-442e-b8c6-35c6de7f35ab", 
            "updatedDate": 1675973456, 
            "finishDate": 1675973456,
            "backupID": "da0f4df9-f567-4a37-94a6-bf8d3e3ef83d",
            "projectID": "0"
        }]}, 
    "message": "SUCCESS", 
    "description": "成功", 
    "statusCode": 800
}

错误码

errorCode	描述
EbsBackup.RegionInfo.Empty	查询资源池信息为空或资源池不存在，请确认资源池ID是否有效
EbsBackup.RegionInfo.AccessFailed	查询资源池失败，请重试。如果多次尝试失败，请提交工单
EbsBackup.RegionInfo.DataDamaged	查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单
EbsBackup.BackupInfo.AccessFailed	查询云硬盘备份失败
EbsBackup.BackupInfo.DataDamaged	云硬盘备份数据不符合预期
EbsBackup.Parameter.InvalidPageParams	请求参数错误：{错误原因}
EbsBackup.Parameter.InvalidRegionID	请求参数错误：{错误原因}
EbsBackup.OrderCheck.InvalidProjectID	企业项目不存在，请确认企业项目ID是否有效

云硬盘备份

查询备份列表