接口功能介绍
查询云主机备份列表
接口约束
- 使用限制,本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
2. 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/backup-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | b6bb383e876c11ea8a5e0242ac110002 | |
pageNo | 否 | Integer | 页码,取值范围:大于等于1,默认值为1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1~50],默认值为10,单页最大记录不超过50 | 10 | |
ID | 否 | String | 云主机ID | de70ef00-1ea0-459a-b74d-b06272561a32 | |
repositoryID | 否 | String | 备份存储库ID | de70ef00-1ea0-459a-b74d-b06272561a32 | |
instanceBackupID | 否 | String | 云主机备份ID | ed48dc25-d6bb-48e6-b202-3e36ee6321a3 | |
queryContent | 否 | String | 模糊匹配查询内容(可是ID或者名称) | backup-test01 | |
status | 否 | String | 云主机备份状态 | ACTIVE | |
projectID | 否 | String | 企业项目ID | 0 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页记录数目 | 1 | |
totalCount | Integer | 总记录数 | 10 | |
totalPage | Integer | 总页数 | 1 | |
results | Array of Objects | 分页明细 | results |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
volumeCount | Integer | 云硬盘数目 | 3 | |
restoreFinishTime | String | 恢复时间 | 2023-07-24T04:00:10Z | |
instanceBackupID | String | 云主机备份ID | ed48dc25-d6bb-48e6-b202-3e36ee6321a3 | |
repoFreezing | Boolean | 存储库是否冻结,取值范围: true:已冻结, false: 未冻结 |
false | |
size | Integer | 云主机备份大小 | 60 | |
repositoryID | String | 备份存储库ID | 986035b0-7862-4a1c-b020-3c2cef81dd6d | |
repositoryName | String | 备份存储库名称 | repo-test01 | |
deleted | Boolean | 是否删除 | false | |
usedSize | Integer | 已使用大小 | 755379636 | |
status | String | 备份状态,取值范围: CREATING: 备份创建中, ACTIVE: 可用, RESTORING: 备份恢复中, DELETING: 删除中, EXPIRED:到期, ERROR:错误 |
ACTIVE | |
description | String | 备份描述 | backup_desc_test | |
instanceID | String | 云主机ID | de70ef00-1ea0-459a-b74d-b06272561a32 | |
instanceName | String | 云主机名称 | ecm-9014 | |
repoExpired | Boolean | 存储库是否到期 | false | |
instanceBackupName | String | 云主机备份名称 | backup-test01 | |
block_device_mappings | Array of Objects | 云主机关联云硬盘映射表 | blockDeviceMappingS | |
createAt | String | 创建时间 | 2023-07-24T04:00:10Z | |
updateAt | String | 更新时间 | 2023-07-24T04:00:10Z | |
finishTime | String | 完成时间 | 023-07-24T04:10:02Z | |
projectID | String | 企业项目ID | 0 |
表 blockDeviceMappingS
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
backup_id | String | 云硬盘备份ID | d270c7e2-275f-43b7-a5a3-7bc52c892972 | |
volume_id | String | 云硬盘ID | d270c7e2-275f-43b7-a5a3-7bc52c892972 | |
boot_volume | Boolean | 是否为启动盘 | true | |
mount_device | String | 云硬盘所挂载的设备 | /dev/vda | |
volume_size | String | 云硬盘大小 | 40 | |
volume_type | String | 云硬盘类型,取值范围: SATA:普通IO SAS:高IO SSD:超高IO SSD-genric:通用型SSD FAST-SSD:极速型SSD |
SAS-public | |
delete_on_termination | Boolean | 是否随所挂载的云主机一起销毁 | true | |
boot_index | Integer | 启动次序 | 0 | |
device_name | String | 挂载的设备名称 | /dev/vda | |
container | String | container | a7135589f022439c1edefc74b9336f7a | |
service_metadata | String | 服务元数据 | a8b318a7-c07f-6eb4-8fb9-72a897cc9f65/volume_25e2248b-a5ca-4e27-b1be-76155ef16dbd/20221031025806/az_nova_backup_0634f102-b14c-42fa-bc35-38f669a9c52a |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"pageNo": 1,
"pageSize": 50,
"repositoryID": "62a7cd2f-55a4-4a65-bb64-6f8352b4f55f",
"instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7",
"queryContent": ""
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [{
"status": "ACTIVE",
"instanceBackupName": "openapi-test-0001-0016",
"volumeCount": 1,
"repoFreezing": false,
"usedSize": 835228300,
"block_device_mappings": [{
"backup_id": "0634f102-b14c-42fa-bc35-38f669a9c52a",
"mount_device": "/dev/vda",
"is_bootable": true,
"volume_type": "SATA-public",
"device_name": "vda",
"volume_size": 40,
"boot_index": 1,
"boot_volume": true,
"volume_id": "25e2248b-a5ca-4e27-b1be-76155ef16dbd",
"container": "a7135589f022439c1edefc74b9336f7a",
"service_metadata": "a8b318a7-c07f-6eb4-8fb9-72a897cc9f65/volume_25e2248b-a5ca-4e27-b1be-76155ef16dbd/20221031025806/az_nova_backup_0634f102-b14c-42fa-bc35-38f669a9c52a",
"delete_on_termination": true
}],
"repositoryID": "0da07640-6e76-4642-8a65-xxxxxxxxxxx",
"updateAt": "2022-10-31T03:09:03Z",
"size": 40,
"finishTime": "2022-10-31T03:09:03Z",
"instanceID": "9e32a0de-f7a5-058a-85f1-xxxxxxxxxxxxx",
"description": "openapi-test",
"deleted": false,
"createAt": "2022-10-31T02:58:04Z",
"repoExpired": false,
"projectID": "0",
"instanceBackupID": "a8b318a7-c07f-6eb4-8fb9-xxxxxxxxxxxx",
"repositoryName": "repo-97e8"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码