接口功能介绍
修改一份私有镜像的名称、描述信息。
接口约束
接口请求成功需至少满足：
1. 所指定的私有镜像的状态应是 active。可使用查询镜像详细信息接口来查询一份镜像的详细信息。
2. 要修改的镜像的名称不能与以下名称重复：
- 已有的私有镜像的名称（可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源）；
- 处于 pending 任务状态的创建私有镜像（镜像文件）任务的镜像名称（可使用查询创建私有镜像（镜像文件）任务列表接口来查询使用镜像文件来创建私有镜像的任务列表）。
3. 可修改的私有镜像属性均为非必填参数，无默认值。不指定则表示不修改相应属性。
4. 对启动方式、最大和最小内存的修改仅对系统盘镜像生效。可使用查询镜像详细信息接口来查询一份镜像的详细信息。
5. 当前对启动方式、最大和最小内存的修改在多可用区资源池下不生效。可使用资源池概况信息查询接口来确认所指定的资源池是否是多可用区资源池。
URI
POST /v4/image/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageID | 是 | String | 镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
| bootMode | 否 | String | 启动方式，取值范围（值：描述）： bios：BIOS 启动方式 uefi：UEFI 启动方式 注意：若镜像系统架构为 aarch64 且当前启动方式为 uefi，则对启动方式的修改不生效。 |
bios | |
| description | 否 | String | 镜像描述信息。注意：长度为 1~128 个字符。 | Test CentOS | |
| imageName | 否 | String | 镜像名称。注意：长度为 2~32 个字符，只能由数字、字母、- 组成，不能以数字、- 开头，且不能以 - 结尾。 | CentOS-test | |
| maximumRAM | 否 | Integer | 最大内存，单位为 GB，取值范围：0（即不限制）/ 1 / 2 / 4 / 8 / 16 / 32 / 64 / 128 / 256 / 512。注意：若取值不为 0 且当前或要修改成的最小内存也不为不限制时，则取值应大于或等于当前或要修改成的最小内存。 | 0 | |
| minimumRAM | 否 | Integer | 最小内存，单位为 GB，取值范围：0（即不限制）/ 1 / 2 / 4 / 8 / 16 / 32 / 64 / 128 / 256 / 512。注意：若取值不为 0 且当前或要修改成的最大内存也不为不限制时，则取值应小于或等于当前或要修改成的最大内存。 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码，取值范围（值：描述）： 800：成功 900：失败 |
800 | |
| error | String | 错误码（product.module.code 三段式码）。 | ||
| errorCode | String | 同“error”参数。 | ||
| message | String | 响应状态描述（一般为英文）。 | ||
| description | String | 响应状态描述（一般为中文）。 | ||
| returnObj | Object | 返回参数。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"regionID": "88f8888888dd88ec888888888d888d8b",
"bootMode": "bios",
"description": "Test CentOS",
"imageName": "CentOS-test",
"maximumRAM": 0,
"minimumRAM": 0
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
