ModifyImageAttribute - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

イメージファミリー、名前、ブートモード、ステータス、NVMe サポートなどのカスタムイメージの属性を変更します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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://` を含めることはできません。数字、ピリオド (.)、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。デフォルト値: null。null の場合、元の名前が保持されます。	testImageName
Status	string	任意	イメージのステータス。有効な値: Deprecated: イメージを非推奨状態にセットします。カスタムイメージを共有している場合は、非推奨状態にセットする前に共有を解除する必要があります。非推奨のイメージは共有またはコピーできません。ただし、このイメージを使用してインスタンスを作成したり、システムディスクを置き換えたりすることは可能です。 Available: イメージを利用可能な状態にセットします。非推奨のイメージを利用可能な状態に解凍できます。説明イメージファミリー内のカスタムイメージを以前のバージョンにロールバックするには、最新の利用可能なカスタムイメージを非推奨状態にセットします。ただし、そのイメージがイメージファミリー内で唯一の利用可能なカスタムイメージである場合、イメージを非推奨にすると、イメージファミリーにはインスタンス作成に使用できる利用可能なカスタムイメージがなくなります。慎重に操作してください。	Deprecated
ImageFamily	string	任意	イメージファミリーの名前。名前の長さは 2～128 文字である必要があります。先頭は英字または漢字にする必要があり、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。数字、ピリオド (.)、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。デフォルト値: null。	hangzhou-daily-update
BootMode	string	任意	イメージのブートモード。有効な値: BIOS: Basic Input/Output System (BIOS) ブートモード。 UEFI: Unified Extensible Firmware Interface (UEFI) ブートモード。 UEFI-Preferred: デュアルブートモード。重要サポートされていないブートモードが原因でインスタンスの起動に失敗しないように、このパラメーターを変更する前に、イメージでサポートされているブートモードを確認してください。イメージのブートモードの詳細については、「イメージのブートモード」を参照してください。列挙値: BIOS : BIOS。 UEFI : UEFI。 UEFI-Preferred : UEFI-Preferred。	BIOS
LicenseType	string	任意	イメージのインポート後にオペレーティングシステムをアクティブ化するために使用されるライセンスタイプ。現在、BYOL のみがサポートされています。 BYOL: ソースオペレーティングシステムに付属するライセンス。BYOL を使用する場合は、お使いのライセンスキーが Alibaba Cloud での使用をサポートしていることを確認してください。	BYOL
Description	string	任意	カスタムイメージの説明。説明の長さは 2～256 文字である必要があり、`http://` または `https://` で始めることはできません。デフォルト値: null。null の場合、元の説明が保持されます。	testDescription
Features	object	任意	イメージの特徴属性。
NvmeSupport	string	任意	イメージの NVMe サポート属性を変更します。このパラメーターが指定されていない場合、現在の値が保持されます。重要この特徴を有効にする前に、オペレーティングシステムに NVMe ドライバーがプリインストールされていることを確認してください。推奨されるプロシージャ: インスタンスにドライバーをインストールし、カスタムイメージを作成してから、この操作を呼び出します。ドライバーなしでこの特徴を強制的に有効にすると、インスタンスの起動に失敗します。	supported
ImdsSupport	string	任意	イメージのメタデータアクセスモード。有効な値: v1: このイメージから ECS インスタンスを作成する場合、メタデータアクセスモードを IMDSv2 のみ (強化モード) に設定することはできません。 v2: このイメージから ECS インスタンスを作成する場合、メタデータアクセスモードを IMDSv2 のみ (強化モード) に設定できます。重要 ImdsSupport を v2 から v1 に変更することはできません。変更が必要な場合は、このイメージに関連付けられているスナップショットから新しいイメージを作成し、値を v1 に設定してください。	v2
DryRun	boolean	任意

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidImageName.Malformed	Image names must be between 2 and 128 characters long, using either English or Chinese characters. The name must start with a letter or a Chinese character, and can include numbers, colons, underscores and hyphens.	イメージ名の長さは 2～128 文字である必要があります。先頭は英字または漢字にする必要があり、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。
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	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.	指定されたイメージのステータスが 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 にポート変更することはできません。
403	InvalidStatus.ImageIsCreating	The operation cannot be performed because the image is creating. Please wait until the creation is complete and try again.	イメージの作成がまだ完了していません。この操作は実行できません。イメージの作成が完了するまで待ってから、再度お試しください。
403	InvalidOperation.PublicImageUnsupported	The community image's publisher is not the current account. Modification is not permitted.	コミュニティイメージのパブリッシャーが現在のアカウントではありません。変更は許可されていません。
403	InvalidDescription.Malformed	The specified parameter description is not valid.	指定された description パラメーターが無効です。
403	InvalidBootMode.SecureBootUnsupported	Secure Boot requires UEFI or UEFI-Preferred boot mode. Please check the BootMode and try again.	セキュアブートには UEFI または UEFI-Preferred ブートモードが必要です。ブートモードを確認して、もう一度お試しください。
404	InvalidImageId.NotFound	The specified ImageId does not exist.	指定されたイメージが見つかりません。現在のリージョンにイメージが存在し、そのステータスが利用可能であることを確認してください。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。