调用ModifyImageAttribute修改一份自定义镜像的名称、描述信息、状态或镜像族系。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ModifyImageAttribute | 系统规定参数。取值:ModifyImageAttribute。 |
RegionId | String | 是 | cn-hangzhou | 自定义镜像所在的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
ImageId | String | 是 | m-bp18ygjuqnwhechc**** | 自定义镜像的ID。 |
ImageName | String | 否 | testImageName | 自定义镜像的名称。长度为2~128个字符。必须以大小写字母或中文开头,不能以aliyun或acs:开头,不能包含http://或者https://。可以包含数字、半角句号(.)、半角冒号(:)、下划线(_)或者短划线(-)。 默认值:空,表示保持原有名称不变。 |
Status | String | 否 | Deprecated | 镜像状态,取值范围:
说明 如果您需要回滚镜像族系中的自定义镜像至上一个版本,可以将最新可用的自定义镜像设置为弃用状态,但如果该镜像为镜像族系中唯一一个可用状态的自定义镜像,则弃用镜像以后该镜像族系将无可用状态自定义镜像用来创建实例,因此请谨慎操作。 |
ImageFamily | String | 否 | hangzhou-daily-update | 镜像族系名称。长度为2~128个字符。必须以大小写字母或中文开头,不能以aliyun或acs:开头,不能包含http://或者https://。可以包含数字、半角句号(.)、半角冒号(:)、下划线(_)或者短划线(-)。 默认值:空。 |
BootMode | String | 否 | BIOS | 修改镜像的启动模式。取值范围:
说明 新建ECS实例会按照修改后镜像启动模式启动,您需要了解当前镜像支持的启动模式后再做修改,避免造成实例无法正常启动的情况出现。如果您不清楚当前镜像支持的启动模式,建议您使用镜像检测感知。关于镜像检测的更多信息,请参见镜像检测概述。 |
LicenseType | String | 否 | BYOL | 导入镜像后,激活操作系统采用的许可证类型。当前仅支持BYOL。 BYOL:源操作系统自带的许可证。采用BYOL时,您必须确保您的许可证密钥支持在阿里云使用。 |
Description | String | 否 | testDescription | 自定义镜像的描述信息。长度为2~256个字符。不能以http://或https://开头。 默认值:空,表示保持原有描述信息不变。 |
Features.NvmeSupport | String | 否 | supported | 镜像是否支持NVMe。取值范围:
|
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | 请求ID。 |
示例
请求示例
http(s)://ecs.aliyuncs.com/?Action=ModifyImageAttribute
&RegionId=cn-hangzhou
&ImageId=m-bp18ygjuqnwhechc****
&ImageName=testImageName
&Status=Deprecated
&ImageFamily=hangzhou-daily-update
&BootMode=BIOS
&Description=testDescription
&Features={"NvmeSupport":"supported"}
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyImageAttributeResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</ModifyImageAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidImageName.Malformed | The specified Image name is wrongly formed. | 镜像名称格式错误。长度为2~128个字符。必须以大小字母或中文开头,不能以aliyun和acs:开头,不能包含http://或者https://。可以包含数字、半角句号(.)、半角冒号(:)、下划线(_)或者短划线(-)。 |
400 | InvalidImageName.Duplicated | The specified Image name has already bean used. | 镜像名称已经重复。 |
400 | InvalidDescription.Malformed | The specified description is wrongly formed. | 指定的资源描述格式不合法。长度为 2-256 个字符,不能以 http:// 和 https:// 开头。 |
403 | ImageStatus.NotAvailable | The specified image status is not available. | 指定的镜像状态不是Available。 |
403 | ImageStatus.NotDeprecated | The specified image status is not deprecated. | 指定的镜像状态未弃用。 |
403 | OperationDeined.ImageUsingByInstance | The boot mode of the image cannot be modified because it has associated instances. | 镜像有关联实例时,不允许修改镜像的启动模式属性 |
404 | InvalidImageId.NotFound | The specified ImageId does not exist. | 指定的镜像在该用户账号下不存在,请您检查镜像 ID 是否正确。 |
访问错误中心查看更多错误码。