接口功能介绍
查询云主机备份列表
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：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资源池进行公测
URI
POST /v4/ecs/backup/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 | |
| instanceID | 否 | 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 | 模糊匹配查询内容（匹配字段：instanceBackupName、instanceBackupID、instanceBackupStatus、instanceName） | backup-test01 | |
| instanceBackupStatus | 否 | String | 云主机备份状态 | ACTIVE | |
| projectID | 否 | String | 企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceBackupID | String | 云主机备份ID | ed48dc25-d6bb-48e6-b202-3e36ee6321a3 | |
| instanceBackupName | String | 云主机备份名称 | auto-2-0002 | |
| instanceBackupStatus | String | 云主机备份状态，取值范围： CREATING: 备份创建中, ACTIVE: 可用， RESTORING: 备份恢复中， DELETING: 删除中， EXPIRED：到期， ERROR：错误 |
ACTIVE | |
| instanceBackupDescription | String | 云主机备份描述 | auto backup | |
| instanceID | String | 云主机ID | de70ef00-1ea0-459a-b74d-b06272561a32 | |
| instanceName | String | 云主机名称 | ecm-9014 | |
| repositoryID | String | 云主机备份存储库ID | 986035b0-7862-4a1c-b020-3c2cef81dd6d | |
| repositoryName | String | 云主机备份存储库名称 | repo-test01 | |
| repositoryExpired | Boolean | 云主机备份存储库是否过期 | false | |
| repositoryFreeze | Boolean | 存储库是否冻结 | false | |
| diskTotalSize | Integer | 云盘总容量大小，单位为GB | 100 | |
| usedSize | Integer | 磁盘备份已使用大小 | 10 | |
| diskCount | Integer | 云盘数目 | 1 | |
| restoreFinishedTime | String | 备份恢复完成时间 | 2023-07-24T04:10:02Z | |
| createdTime | String | 创建时间 | 2023-07-24T04:00:10Z | |
| finishedTime | String | 完成时间 | 2023-07-24T04:00:10Z | |
| projectID | String | 企业项目ID | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：查询在该备份存储库下的云主机备份列表
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"repositoryID": "62a7cd2f-55a4-4a65-bb64-6f8352b4f55f",
"instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"
}
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 41,
"totalPage": 21,
"results": [{
"instanceBackupID": "58b42997-4f95-bf60-85af-17a8e80242e6",
"instanceBackupName": "openapi-test9",
"instanceBackupDescription": "openapi test9",
"instanceBackupStatus": "ACTIVE",
"instanceID": "b3721e53-7d5c-52d4-4572-581b5abe7807",
"instanceName": null,
"repositoryID": "353026fc-ed30-47b0-ab8a-62717a6919d6",
"repositoryName": "repo-f1b0",
"diskTotalSize": 45,
"usedSize": 0,
"restoreFinishedTime": null,
"diskCount": 0,
"createdTime": "2023-01-10T02:16:26Z",
"finishedTime": null,
"projectID": "0",
"repositoryFreeze": false,
"repositoryExpired": false
}, {
"instanceBackupID": "df8dacda-7f76-6d1d-546a-f16e0c0bd005",
"instanceBackupName": "manualbk-z4s7",
"instanceBackupDescription": "manual backup",
"instanceBackupStatus": "ACTIVE",
"instanceID": "142dcec0-31c4-1f50-708a-43a7edb94a52",
"instanceName": null,
"repositoryID": "f5b4d335-d36b-4dd6-b3a0-bca28b4d33ab",
"repositoryName": "repo-55cf",
"diskTotalSize": 45,
"usedSize": 819598338,
"restoreFinishedTime": null,
"diskCount": 2,
"createdTime": "2023-02-01T04:46:44Z",
"finishedTime": "2023-02-01T04:58:42Z",
"projectID": "0",
"repositoryFreeze": false,
"repositoryExpired": false
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
