批量更新云主机备份信息
接口功能介绍
批量更改云主机备份名称和描述
接口约束
- 使用限制,本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/backup-batch-update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
updateInfo | 是 | Array of Objects | 云主机备份更新信息 | updateInfo |
表 updateInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceBackupID | 是 | String | 云主机备份ID | b6e2966d-7b1c-385e-abe4-d940caa273b7 | |
name | 否 | String | 云主机备份名称,长度为2~63个字符 | update-test01 | |
description | 否 | String | 云主机备份描述 | api_update_test01 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 空 | {} |
请求示例
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"updateInfo":[
{
"instanceBackupID": "a8b318a7-c07f-6eb4-8fb9-72a897cc9f65",
"name": "openapi-test-0001-0016_update2_batch",
"description": "openapi-test-0001-0016_update1"
},
{
"instanceBackupID": "a8b318a7-c07f-6eb4-8fb9-72a897cc9f65",
"name": "openapi-test-0001-0016_update2_batch2",
"description": "openapi-test-0001-0016_update1"
}
]
}
响应示例
{
"returnObj": {},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Ecs.Parameter.InvalidNotValid | 请求参数非法 |
EcsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Openapi.EcsBackupWorkorder.UpdateError | 更新失败 |
Openapi.EcsBackupWorkorder.AccessFailed | 获取备份失败 |
Openapi.EcsBackupParameter.NotValid | 请求参数非法 |
Openapi.NameCheck.NotValid | name格式非法 |
Ecs.Backup.NotFound | 找不到备份 |
EcsBackup.NameCheck.NameNull | 名字空 |
Ecs.UpdateInfo.Null | 批量更新信息空 |
EcsBackup.IDCheck.IDNull | 备份ID空 |
EcsBackup.NameCheck.NoChange | 名字未改变 |