批量更新云主机快照信息
接口功能介绍
批量更改云主机快照名称和描述
接口约束
无
URI
POST /v4/ecs/snapshot/batch-update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 81f77299999999999999999999999 | |
updateInfo | 是 | Array of Objects | 云主机备份更新信息 | updateInfo |
表 updateInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
snapshotID | 是 | String | 云主机快照ID | d4d4ee2b-1478-0e0b-53e6-10e738cfc58c | |
snapshotName | 是 | String | 云主机快照名称,满足以下规则:不能使用中文,且长度为2~63个字符 | snapshot_update_batch01 | |
snapshotDescription | 否 | String | 云主机快照描述 | snapshot_update_des |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | {} | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotIDList | Array of Strings | 云主机快照ID | ["d4d4ee2b-1478-0e0b-53e6-10e738cfc58c", "d311b4c1-d77d-e297-ca75-7a672e475380"] |
请求示例
请求头header
无
请求体body
{
"regionID": "81f77299999999999999999999999",
"updateInfo":[
{
"snapshotID": "d4d4ee2b-1478-0e0b-53e6-10e738cfc58c",
"snapshotName": "snapshot_update_batch01",
"snapshotDescription": "snapshot_update_des"
},
{
"snapshotID": "d311b4c1-d77d-e297-ca75-7a672e475380",
"snapshotName": "snapshot_update_batch02",
"snapshotDescription": "snapshot_update_des"
}
]
}
响应示例
{
"returnObj": {
"snapshotIDList": ["d4d4ee2b-1478-0e0b-53e6-10e738cfc58c", "d311b4c1-d77d-e297-ca75-7a672e475380"]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Openapi.SnapshotWorkOrder.AccessFailed | 查询快照信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Snapshot.InfoNotFound | 未查询到云主机快照信息,请确认云主机快照是否存在 |
Ecs.Snapshot.NameNotValid | 快照名称无效,应满足以下规则:不能使用中文,且长度为2-63字符 |
Ecs.Snapshot.IDRepeat | 快照ID重复,请输入有效的快照ID |
Ecs.Snapshot.NameNoChange | 快照名称无变化,请输入有效的快照名称 |
Openapi.SnapshotWorkOrder.UpdateError | 更新快照失败,请重试。如果多次尝试失败,请提交工单 |