接口功能介绍
更改云主机快照名称和描述
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1.云主机快照必须存在
2.云主机快照名称必须与使用的不同
3.云主机快照名称不能重复
4.云主机快照状态为“正常”
URI
POST /v4/ecs/snapshot/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
snapshotID | 是 | String | 云主机快照ID, 获取: 查 查询云主机快照列表 创 创建云主机快照 |
b6e2966d-7b1c-385e-abe4-d940caa273b7 | |
snapshotName | 是 | String | 云主机快照名称。满足以下规则:长度为2-63字符,头尾不支持输入空格 | snapshot_update_01 | |
snapshotDescription | 是 | String | 云主机快照描述,字符长度不超过256字符 | snapshot_des |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotID | String | 云主机快照ID | b6e2966d-7b1c-385e-abe4-d940caa273b7 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:在华东1资源池更新一个快照的名称和描述信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"snapshotID": "b6e2966d-7b1c-385e-abe4-d940caa273b7",
"snapshotName": "snapshot_update_01",
"snapshotDescription": "snapshot_des"
}
响应示例
{
"returnObj": {
"snapshotID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码