接口功能介绍
更改云主机备份名称和描述
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：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.云主机备份必须存在
URI
POST /v4/ecs/backup/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceBackupID | 是 | String | 云主机备份ID，您可以查看产品定义-云主机备份来了解云主机备份 获取： 查 查询云主机备份 创 创建云主机备份 |
b6e2966d-7b1c-385e-abe4-d940caa273b7 | |
| instanceBackupName | 是 | String | 云主机备份名称。满足以下规则：以大小写字母开头，可包含数字，‘_’或‘-’，长度为2-63字符 注：在所有资源池不可重复 |
update-test01 | |
| instanceBackupDescription | 否 | String | 云主机备份描述，字符长度不超过256字符 | api_update_test01 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceBackupID | String | 云主机备份ID | b6e2966d-7b1c-385e-abe4-d940caa273b7 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：将云主机备份的名称和描述进行更新
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7",
"instanceBackupName": "test_zz-0001-zzy1",
"instanceBackupDescription": "ecs-backups-test_zz-0001-zzy"
}
响应示例
{
"returnObj": {
"instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
