接口功能介绍
批量更改云主机快照名称和描述
接口约束
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/snapshot-batch-update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | ||
updateInfo | 是 | Array of Objects | 云主机快照更新信息 | updateInfo |
表 updateInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
snapshotID | 是 | String | 云主机快照ID | 'd4d4ee2b-1478-0e0b-53e6-10e738cfc58c' | |
name | 是 | String | 云主机快照名称,满足以下规则:长度为2-63字符,头尾不支持输入空格 | ||
description | 否 | String | 云主机快照描述,字符长度不超过256字符 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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'] |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f77299999999999999999999999",
"updateInfo":[
{
"snapshotID": "d4d4ee2b-1478-0e0b-53e6-10e738cfc58c",
"name": "snapshot_test1101_9_update9_batch1",
"description": "snapshot_test1101_9_update6_des"
},
{
"snapshotID": "d311b4c1-d77d-e297-ca75-7a672e475380",
"name": "snapshot_test1101_9_update9_batch2",
"description": "snapshot_test1101_9_update6_des"
}
]
}
响应示例
{
"returnObj": {
"snapshotIDList": ["d4d4ee2b-1478-0e0b-53e6-10e738cfc58c", "d311b4c1-d77d-e297-ca75-7a672e475380"]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码