接口功能介绍
查询云硬盘备份信息。
当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
接口约束
无
URI
GET /v4/ebs-backup/show
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
backupID | 是 | String | 云硬盘备份ID | 59093d15-8a3c-53b9-b61b-484af10a3e97 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 类型 | 描述 | 示例 | 下级对象 |
---|---|---|---|---|---|
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-失败,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
无
响应示例
{
"statusCode": 800,
"message": "SUCCESS",
"description": "成功",
"returnObj": {
"regionID": "xxxx",
"backupID": "xxx",
"backupName": "bakName",
"status": "available",
"size": 100,
"usedSize": 10,
"description": "backup for xxx",
"repositoryID": "xxx",
"repositoryName": "backupRepositoryName",
"createdDate": 1663136607,
"updatedDate": 1663136607,
"finishDate": 1663136607,
"restoreDate": 1663136607,
"restoreFinishDate": 1663136607,
"freeze": false,
"volumeID": "xxx",
"volumeName": "ebs",
"encrypted": false,
"cmkUUID": "",
"volumeType": "SATA",
"azName": "az2",
"paas": true,
"vMID": "xxx",
"vMName": "VMNAME",
"projectID": "0"
}
}
错误码
errorCode | 描述 |
---|---|
EbsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
EbsBackup.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
EbsBackup.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
EbsBackup.BackupInfo.Empty | 云硬盘备份为空 |
EbsBackup.BackupInfo.NotFound | 云硬盘备份未找到 |
EbsBackup.BackupInfo.AccessFailed | 查询云硬盘备份失败 |
EbsBackup.BackupInfo.DataDamaged | 云硬盘备份数据不符合预期 |
EbsBackup.Parameter.InvalidRegionID | 请求参数错误:{错误原因} |