接口功能介绍
创建云主机备份
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：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资源池进行公测
2.云主机和备份存储库必须存在
3.当备份存储库的容量小于0，已到期或已冻结这些情况下，备份存储库不可用
4.云主机的状态必须处于开机或关机状态下
URI
POST /v4/ecs/backup/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 |
a628a7d9-ef97-3b16-8a0a-4a794fcdbc39 | |
| instanceBackupName | 是 | String | 云主机备份名称。满足以下规则：以大小写字母开头，可包含数字，‘_’或‘-’，长度为2-63字符 | api-temp01 | |
| instanceBackupDescription | 否 | String | 云主机备份描述，字符长度不超过256字符 | creat_test01 | |
| repositoryID | 是 | String | 云主机备份存储库ID，您可以查看产品定义-存储库来了解存储库 获取： 查 查询存储库 创 创建存储库 |
bbf404b5-8990-42a7-a144-c85ff4520276 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Object | 备份结果 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceBackupID | String | 云主机备份ID | 8a134233-5881-bacf-9ae0-992f4380698a | |
| instanceBackupName | String | 云主机备份名称 | api-temp01 | |
| instanceBackupStatus | String | 备份状态，取值范围： CREATING: 备份创建中, ACTIVE: 可用， RESTORING: 备份恢复中， DELETING: 删除中， EXPIRED：到期， ERROR：错误 |
CREATING | |
| instanceBackupDescription | String | 云主机备份描述 | create_test01 | |
| instanceID | String | 云主机ID | a628a7d9-ef97-3b16-8a0a-4a794fcdbc39 | |
| instanceName | String | 云主机名称 | backupTS | |
| repositoryID | String | 云主机备份存储库ID | bbf404b5-8990-42a7-a144-c85ff4520276 | |
| repositoryName | String | 云主机备份存储库名称 | api-temp01 | |
| diskTotalSize | Integer | 云盘总容量大小，单位为GB | 40 | |
| usedSize | Integer | 云硬盘备份已使用大小 | 0 | |
| createdTime | String | 创建时间 | 2023-07-20T07:24:29Z | |
| projectID | String | 企业项目ID | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：在备份存储库中创建一台云主机的备份
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"instanceID":"cb51e0db-8e20-7434-4208-2a6fef86588f",
"repositoryID":"96a06145-146d-4f6f-907c-34a7f57d7fda",
"instanceBackupName":"test",
"instanceBackupDescription":"test"
}
响应示例
{
"returnObj": {
"results": {
"instanceBackupID": "36e17e43-f62d-060d-ce7c-ebac509faff9",
"instanceBackupName": "test-0006",
"instanceBackupDescription": "test",
"instanceID": "cb51e0db-8e20-7434-4208-2a6fef86588f",
"instanceName": "test",
"repositoryID": "96a06145-146d-4f6f-907c-34a7f57d7fda",
"repositoryName": "test",
"instanceBackupStatus": "CREATING",
"diskTotalSize": 45,
"usedSize": 0,
"createdTime": "2023-03-09T12:33:35Z",
"projectID": "0"
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
