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

ModifyImageAttribute API を呼び出して、カスタムイメージの属性 (イメージファミリー、名前、ブートモード、ステータス、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 です。最新の Alibaba Cloud リージョンリストは、DescribeRegions API を呼び出して確認できます。	cn-hangzhou
ImageId	string	必須	カスタムイメージの ID です。	m-bp18ygjuqnwhechc****
ImageName	string	任意	カスタムイメージの名前です。名前は 2～128 文字である必要があります。先頭は英字または漢字である必要があります。 `aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることもできません。数字、ピリオド (.)、コロン (:)、アンダースコア (_) およびハイフン (-) を使用できます。このパラメーターを指定しない場合、元の名前を保持します。	testImageName
Status	string	任意	イメージのステータスです。有効な値： `Deprecated`：イメージを非推奨にします。非推奨にするカスタムイメージが共有されている場合は、先に共有を解除する必要があります。非推奨のイメージは共有またはコピーできません。ただし、このイメージを使用してインスタンスを作成したり、システムディスクを置き換えたりできます。 `Available`：イメージを利用可能にします。非推奨のイメージのステータスを `Available` に変更できます。説明ただし、これがイメージファミリー内で唯一の利用可能なカスタムイメージである場合、これを非推奨にすると、そのファミリー内のいずれのイメージからもインスタンスを作成できなくなります。このオプションは慎重に使用してください。	Deprecated
ImageFamily	string	任意	イメージファミリーの名前です。名前は 2～128 文字である必要があります。先頭は英字または漢字である必要があります。 `aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることもできません。数字、ピリオド (.)、コロン (:)、アンダースコア (_) およびハイフン (-) を使用できます。デフォルトでは、このパラメーターは空です。	hangzhou-daily-update
BootMode	string	任意	イメージの起動モードです。有効な値： `BIOS`：BIOS 起動モード。 `UEFI`：UEFI 起動モード。 `UEFI-Preferred`：UEFI 優先の起動モード。重要起動失敗を防ぐため、起動モードを変更する前に、イメージがサポートしている起動モードを確認してください。詳細については、「Boot modes」をご参照ください。列挙値: BIOS : BIOS UEFI : UEFI UEFI-Preferred : UEFI-Preferred	BIOS
LicenseType	string	任意	イメージのインポート後にオペレーティングシステムをアクティベートするためのライセンスタイプです。有効な値は `BYOL` のみです。 `BYOL`：BYOL (Bring Your Own License)。BYOL (Bring Your Own License) を使用する場合は、Alibaba Cloud で使用できるライセンスキーであることを確認してください。	BYOL
Description	string	任意	カスタムイメージの新しい説明です。説明は 2～256 文字である必要があり、`http://` または `https://` で始めることはできません。このパラメーターを指定しない場合、元の説明を保持します。	testDescription
Features	object	任意	イメージの機能です。
NvmeSupport	string	任意	イメージが NVMe をサポートしているかどうかを指定します。有効な値： `supported`：イメージは NVMe をサポートします。このイメージから作成したインスタンスは NVMe プロトコルをサポートします。 `unsupported`：イメージは NVMe をサポートしません。このイメージから作成したインスタンスは NVMe プロトコルをサポートしません。	supported
ImdsSupport	string	任意	イメージのメタデータアクセスモードです。有効な値： `v1`：このイメージから ECS インスタンスを作成する場合、メタデータアクセスモードを `強制モード` に設定できません。 `v2`：このイメージから ECS インスタンスを作成する場合、メタデータアクセスモードを `強制モード` に設定できます。重要 `ImdsSupport` の値を `v2` から `v1` に変更することはできません。 `v1` モードを使用するには、イメージに関連付けられているスナップショットから新しいイメージを作成し、`ImdsSupport` を `v1` に設定してください。	v2
DryRun	boolean	任意	リクエストが有効かどうかを確認するために、ドライランを実行するかどうかを指定します。有効な値： `true`：ドライランを実行し、リクエストの有効性、構文、必要な権限を確認します。ドライランに失敗した場合は、エラーメッセージが返されます。ドライランに成功した場合は、`DryRunOperation` エラーコードが返されます。 `false` (デフォルト)：リクエストを送信します。検証チェックに合格した場合、操作が実行されます。

レスポンスフィールド

フィールド	型	説明	例
	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.
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.
403	ImageStatus.NotAvailable	The specified image status is not 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.
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.
404	InvalidImageId.NotFound	The specified ImageId does not exist.

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

変更履歴

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