文档

ModifyImageAttribute - 修改自定义镜像属性

更新时间:

调用ModifyImageAttribute修改一份自定义镜像的名称、描述信息、状态或镜像族系。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:ModifyImageAttributeWrite
  • Image
    acs:ecs:{#regionId}:{#accountId}:image/{#imageId}

请求参数

名称类型必填描述示例值
RegionIdstring

自定义镜像所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ImageIdstring

自定义镜像的 ID。

m-bp18ygjuqnwhechc****
ImageNamestring

自定义镜像的名称。长度为 2~128 个字符。必须以大小字母或中文开头,不能以 aliyun 或 acs:开头,不能包含 http://或者 https://。可以包含数字、半角句号(.)、半角冒号(:)、下划线(_)或者短划线(-)。

默认值:空,表示保持原有名称不变。

testImageName
Statusstring

镜像状态,取值范围:

  • Deprecated:将镜像设置为弃用状态。如果您已经共享的自定义镜像,必须先取消共享才能修改为弃用状态。对处于弃用状态镜像,不能共享和复制镜像。但是可以使用镜像创建实例或更换系统盘。
  • Available:将镜像设置为可用状态。您可以将弃用状态的镜像恢复可用。
说明 如果您需要回滚镜像族系中的自定义镜像至上一个版本,可以将最新可用的自定义镜像设置为弃用状态,但如果该镜像为镜像族系中唯一一个可用状态的自定义镜像,则弃用镜像以后该镜像族系将无可用状态自定义镜像用来创建实例,因此请谨慎操作。
Deprecated
ImageFamilystring

镜像族系名称。长度为 2~128 个字符。必须以大小字母或中文开头,不能以 aliyun 或 acs:开头,不能包含 http://或者 https://。可以包含数字、半角句号(.)、半角冒号(:)、下划线(_)或者短划线(-)。

默认值:空。

hangzhou-daily-update
BootModestring

修改镜像的启动模式。取值范围:

  • BIOS:BIOS 启动模式。
  • UEFI:UEFI 启动模式。
  • UEFI-Preferred:双启动模式。
说明 建议您了解当前镜像支持的启动模式后再做修改,避免造成实例无法正常启动的情况出现。如果您不清楚当前镜像支持的启动模式,建议您使用镜像检测感知。关于镜像检测的更多信息,请参见镜像检测概述
说明 有关镜像 UEFI-Preferred 启动模式的说明,请参见 ECS 实例启动模式最佳实践
BIOS
LicenseTypestring

导入镜像后,激活操作系统采用的许可证类型。当前仅支持 BYOL。

BYOL:源操作系统自带的许可证。采用 BYOL 时,您必须确保您的许可证密钥支持在阿里云使用。

BYOL
Descriptionstring

自定义镜像的描述信息。长度为 2~256 个字符。不能以 http://或 https://开头。

默认值:空,表示保持原有描述信息不变。

testDescription
Featuresobject

镜像特性相关属性。

NvmeSupportstring

镜像是否支持 NVMe。可能值:

  • supported:支持。表示以该镜像创建的实例支持 NVMe 协议。
  • unsupported:不支持。表示以该镜像创建的实例不支持 NVMe 协议。
supported

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidImageName.MalformedThe specified Image name is wrongly formed.镜像名称格式错误。长度为2~128个字符。必须以大小字母或中文开头,不能以aliyun和acs:开头,不能包含http://或者https://。可以包含数字、半角句号(.)、半角冒号(:)、下划线(_)或者短划线(-)。
400MissingParameterThe input parameter "RegionId" that is mandatory for processing this request is not supplied.-
400InvalidImageName.DuplicatedThe specified Image name has already bean used.镜像名称已经重复。
400InvalidDescription.MalformedThe specified description is wrongly formed.指定的资源描述格式不合法。长度为 2-256 个字符,不能以 http:// 和 https:// 开头。
400ImageQuotaFull.ImageFamilyThe specified image family has exceeded max number of images for one image family.-
400InvalidImageFamily.MalformedThe specified parameter "ImageFamily" is malformed.-
400ImageFamilyQuotaFullThe specified region has exceeded max number of image family.-
400InvalidBootMode.NotSupportThe specified parameter BootMode is not supported.-
400InvalidLicenseType.NotSupportedThe specified parameter LicenseType is not supported.-
403ImageStatus.NotAvailableThe specified image status is not available.指定的镜像状态不是Available。
403ImageStatus.NotDeprecatedThe specified image status is not deprecated.指定的镜像状态未弃用。
403ImageUseSharedThe specified image has been shared to others, please remove shared accounts first.-
403OperationDeined.ImageUsingByInstanceThe boot mode of the image cannot be modified because it has associated instances.镜像有关联实例时,不允许修改镜像的启动模式属性
404InvalidImageId.NotFoundThe specified ImageId does not exist.指定的镜像在该用户账号下不存在,请您检查镜像 ID 是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-11-30OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
  • 本页导读 (1)