調用ModifyImageAttribute接口，并可以指定ImageId、ImageFamily等參數，修改一份自定義鏡像的屬性，例如鏡像族系、名稱、啟動模式、狀態以及是否支持NVMe等。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:ModifyImageAttribute | update | *Image acs:ecs:{#regionId}:{#accountId}:image/{#imageId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 自定義鏡像所在的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ImageId | string | 是 | 自定義鏡像的 ID。 | m-bp18ygjuqnwhechc**** |
| ImageName | string | 否 | 自定義鏡像的名稱。長度為 2~128 個字符。必須以大小字母或中文開頭，不能以 aliyun 或 acs:開頭，不能包含 http://或者 https://。可以包含數字、半角句號（.）、半角冒號（:）、下劃線（_）或者短劃線（-）。 默認值：空，表示保持原有名稱不變。 | testImageName |
| Status | string | 否 | 鏡像狀態，取值范圍：
說明
如果您需要回滾鏡像族系中的自定義鏡像至上一個版本，可以將最新可用的自定義鏡像設置為棄用狀態，但如果該鏡像為鏡像族系中唯一一個可用狀態的自定義鏡像，則棄用鏡像以后該鏡像族系將無可用狀態自定義鏡像用來創建實例，因此請謹慎操作。
| Deprecated |
| ImageFamily | string | 否 | 鏡像族系名稱。長度為 2~128 個字符。必須以大小字母或中文開頭，不能以 aliyun 或 acs:開頭，不能包含 http://或者 https://。可以包含數字、半角句號（.）、半角冒號（:）、下劃線（_）或者短劃線（-）。 默認值：空。 | hangzhou-daily-update |
| BootMode | string | 否 | 修改鏡像的啟動模式。取值范圍：
注意
為了避免使用鏡像不支持的啟動模式導致實例無法正常啟動，請您務必在修改之前了解目標鏡像支持的啟動模式。鏡像啟動模式詳情，請參見鏡像啟動模式。
| BIOS |
| LicenseType | string | 否 | 導入鏡像后，激活操作系統采用的許可證類型。當前僅支持 BYOL。 BYOL：源操作系統自帶的許可證。采用 BYOL 時，您必須確保您的許可證密鑰支持在阿里云使用。 | BYOL |
| Description | string | 否 | 自定義鏡像的描述信息。長度為 2~256 個字符。不能以 http://或 https://開頭。 默認值：空，表示保持原有描述信息不變。 | testDescription |
| Features | object | 否 | 鏡像特性相關屬性。 | |
| NvmeSupport | string | 否 | 鏡像是否支持 NVMe。可能值：
| supported |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidImageName.Malformed | The specified Image name is wrongly formed. | 鏡像名稱格式錯誤。長度為2~128個字符。必須以大小字母或中文開頭，不能以aliyun和acs:開頭，不能包含http://或者https://。可以包含數字、半角句號（.）、半角冒號（:）、下劃線（_）或者短劃線（-）。 |
| 400 | MissingParameter | The input parameter "RegionId" that is mandatory for processing this request is not supplied. | - |
| 400 | InvalidImageName.Duplicated | The specified Image name has already bean used. | 鏡像名稱已經重復。 |
| 400 | InvalidDescription.Malformed | The specified description is wrongly formed. | 指定的資源描述格式不合法。長度為 2-256 個字符，不能以 http:// 和 https:// 開頭。 |
| 400 | ImageQuotaFull.ImageFamily | The specified image family has exceeded max number of images for one image family. | - |
| 400 | InvalidImageFamily.Malformed | The specified parameter "ImageFamily" is malformed. | - |
| 400 | ImageFamilyQuotaFull | The specified region has exceeded max number of image family. | - |
| 400 | InvalidBootMode.NotSupport | The specified parameter BootMode is not supported. | - |
| 400 | InvalidLicenseType.NotSupported | The specified parameter LicenseType is not supported. | - |
| 400 | InvalidBootMode.NotSupport | The specified parameter BootMode is not supported for current image architecture. | 當前的鏡像架構不支持設置該啟動模式。 |
| 400 | InvalidParameter.FeaturesImdsSupport | The specified parameter Features.ImdsSupport is not supported. | 指定的參數Features.ImdsSupport不支持。 |
| 403 | ImageStatus.NotAvailable | The specified image status is not available. | 指定的鏡像狀態不是Available。 |
| 403 | ImageStatus.NotDeprecated | The specified image status is not deprecated. | 指定的鏡像狀態未棄用。 |
| 403 | ImageUseShared | The specified image has been shared to others, please remove shared accounts first. | - |
| 403 | OperationDeined.ImageUsingByInstance | The boot mode of the image cannot be modified because it has associated instances. | 鏡像有關聯實例時，不允許修改鏡像的啟動模式屬性 |
| 403 | InvalidOperation.FeaturesImdsSupportNotMatch | The specified parameter Features.ImdsSupport can not be set to v1 from v2. | 指定的參數Features.ImdsSupport不能從v2設置成v1. |
| 404 | InvalidImageId.NotFound | The specified ImageId does not exist. | 指定的鏡像在該用戶賬號下不存在，請您檢查鏡像 ID 是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-05 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-11-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |