接口功能介绍
修改 1 份私有镜像的名称、描述信息等属性。
准备：
1. 在调用前需了解如何构造请求，可参见：如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用，可参见：如何调用 API - 认证鉴权。
注意：在调用前，请您认真阅读此文档，包括但不限于参数描述中的“注意”部分。
接口约束
接口请求成功需至少满足：
1. 您具有调用此接口的权限。
2. 传入的有取值范围的参数的值在取值范围内且满足要求。
3. 传入的 description 参数所指定的描述信息满足要求。
4. 传入的 imageID 参数所指定的镜像满足要求。
5. 传入的 imageName 参数所指定的镜像名称满足要求。
6. 传入的 regionID 参数所指定的资源池对您而言是存在的。
URI
POST /v4/image/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageID | 是 | String | 镜像 ID。可使用查询可以使用的镜像资源接口来查询您可使用的镜像资源，可使用查询镜像详细信息接口来查询 1 份镜像的详细信息。注意：所指定的镜像应是镜像状态为 active 的私有镜像。 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b | |
| bootMode | 否 | String | x86_64 架构非数据盘镜像的启动方式。默认传入的 imageID 参数所指定的镜像的启动方式。取值范围（值：描述）： bios：BIOS 启动方式。 uefi：UEFI 启动方式。 注意：仅在以下条件均满足时生效。 1. 传入的 imageID 参数所指定的镜像是系统架构为 x86_64、镜像类型为空（系统盘镜像）或 full_ecs_image 的云主机镜像。 2. 传入的 regionID 参数所指定的资源池具备 x86_64 UEFI 启动方式功能。 |
bios | |
| description | 否 | String | 描述信息。注意： 1. 长度为 1~128 个字符，不能以空格开头或结尾。 2. 若此参数值等效为空，则描述信息将被清空。 |
Test CTyunOS | |
| imageName | 否 | String | 镜像名称。默认传入的 imageID 参数所指定的镜像的镜像名称。注意： 1. 长度为 2~32 个字符，只能由数字、字母、- 组成，不能以数字、- 开头，且不能以 - 结尾。 2. 不能与您已有的私有镜像（传入的 imageID 参数所指定的镜像除外）的名称重复。可使用查询可以使用的镜像资源接口来查询您已有的私有镜像。 |
CTyunOS-test | |
| maximumRAM | 否 | Integer | 最大内存。单位为 GiB。默认传入的 imageID 参数所指定的镜像的最大内存。取值范围：0（不限制）/1/2/4/8/16/32/64/128/256/512。注意： 1. 若同时限制最大和最小内存，则最大内存不能小于最小内存。 2. 仅在传入的 imageID 参数所指定的镜像是镜像类型为空（系统盘镜像）的云主机镜像且传入的 regionID 参数所指定的资源池具备设置最大/最小内存的功能时生效。 |
0 | |
| minimumRAM | 否 | Integer | 最小内存。单位为 GiB。默认传入的 imageID 参数所指定的镜像的最小内存。取值范围：0（不限制）/1/2/4/8/16/32/64/128/256/512。注意： 1. 若同时限制最大和最小内存，则最大内存不能小于最小内存。 2. 仅在传入的 imageID 参数所指定的镜像是镜像类型为空（系统盘镜像）的云主机镜像且传入的 regionID 参数所指定的资源池具备设置最大/最小内存的功能时生效。 |
0 | |
| supportXSSD | 否 | Boolean | 用于表示是否支持 XSSD 类型盘的标识。默认传入的 imageID 参数所指定的镜像的对应标识值。注意：仅在传入的 imageID 参数所指定的镜像是磁盘格式为 raw、镜像类型为空（系统盘镜像）或 full_ecs_image 的云主机镜像且传入的 regionID 参数所指定的资源池具备设置用于表示是否支持 XSSD 类型盘的标识的功能时生效。 | false |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。取值范围（值：描述）： 800：成功。 900：失败。 |
800 | |
| error | String | 错误码（product.module.code 三段式码）。 | Openapi.PatternCheck.NotValid | |
| errorCode | String | 同 error 参数。 | Openapi.PatternCheck.NotValid | |
| message | String | 响应状态描述（一般为英文）。 | SUCCESS | |
| description | String | 响应状态描述（一般为中文）。 | 成功 | |
| returnObj | Object | 成功时返回的数据。 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：若您在华东 1 有 1 份 ID 为 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa 的私有镜像，则可参考如下形式修改私有镜像属性。
{
"description": "Test CTyunOS",
"imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
"regionID": "bb9fdb42056f11eda1610242ac110002"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
