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

イメージコンポーネントを作成します。イメージコンポーネントは、イメージビルド用の一般的に使用されるビルドテンプレートコマンドを保存するために使用されます。

操作説明

イメージコンポーネントを作成する前に、以下の項目に注意してください:

カスタムイメージコンポーネントのみ作成できます。
コンポーネントのバージョン番号は、同じコンポーネント名に対して一意である必要があります。テンプレートでコンポーネントを使用する場合、名前とバージョン番号でリファレンスできます。
イメージコンポーネントのコンテンツサイズは 16 KB を超えることはできません。サポートされるコマンドの詳細については、Image Builder でサポートされるコマンドを参照してください。

詳細については、Image Builder の概要を参照してください。

今すぐお試しください

この 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:CreateImageComponent

create

*ImageComponent

acs:ecs:{#regionId}:{#accountId}:imagecomponent/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ResourceGroupId	string	任意	エンタープライズリソースグループの ID。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	タグ。
	object	任意
Key	string	任意	タグキー。N の有効な値: 1～20。タグキーは空文字列にできません。タグキーは最大 128 文字で、aliyun または acs: で始めることはできません。タグキーに http:// または https:// を含めることはできません。	TestKey
Value	string	任意	タグ値。N の有効な値: 1～20。タグ値は空文字列にできます。タグ値は最大 128 文字で、acs: で始めることはできません。タグ値に http:// または https:// を含めることはできません。	TestValue
Name	string	任意	コンポーネント名。名前は 2～128 文字で、英字または中国語文字で始める必要があります。名前は http:// または https:// で始めることはできません。名前には英字、中国語文字、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、またはハイフン (-) を含めることができます。説明 `Name` を指定しない場合、デフォルトで `ImageComponentId` の戻り値が使用されます。	testComponent
Description	string	任意	説明。説明は 2～256 文字で、http:// または https:// で始めることはできません。	This is description.
SystemType	string	任意	コンポーネントがサポートするオペレーティングシステム。有効な値: Linux Windows デフォルト値: Linux。	Linux
ComponentType	string	任意	コンポーネントタイプ。イメージビルドコンポーネントとテストコンポーネントがサポートされています。有効な値: Build Test デフォルト値: Build。説明 Build コンポーネントはビルドテンプレートでのみ使用でき、Test コンポーネントはテストテンプレートでのみ使用できます。	Build
Content	string	任意	コンポーネントの内容。内容は複数のコマンドで構成され、16 KB を超えることはできません。サポートされるコマンドとコマンドの初期化の詳細については、Image Builder でサポートされるコマンドを参照してください。	Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken の値は ASCII 文字のみを含み、64 文字を超えることはできません。詳細については、べき等性を確保する方法を参照してください。	123e4567-e89b-12d3-a456-426655440000
ComponentVersion	string	任意	コンポーネントのバージョン番号。このパラメーターはコンポーネント名と組み合わせて使用されます。初期化は major.minor.patch で、すべての値は非負整数です。デフォルト値: (x+1).0.0。x はコンポーネントの現在の最大メジャーバージョン番号です。	1.0.0

レスポンスフィールド

フィールド	型	説明	例
	object
ImageComponentId	string	イメージコンポーネントの ID。	ic-bp67acfmxazb4p****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "ImageComponentId": "ic-bp67acfmxazb4p****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidCommand.Component	Image component does not support component command.
400	InvalidName.Malformed	%s
400	InvalidDescription.Malformed	%s
400	InvalidSystemType.NotSupportedValue	%s
400	InvalidComponentType.NotSupportedValue	%s
400	InvalidContent.LengthExceeded	%s
400	InvalidImageTemplateCommandSize.ExceededMaxNumber	%s
400	InvalidImageTemplateCommand.NotSupported	%s
400	InvalidCommandContent.RUN	%s
400	InvalidCommandContent.ENV	%s
400	InvalidCommandContent.WORKDIR	%s
400	InvalidCommandContent.COPY	%s
400	InvalidCommandContent.USER	%s
400	InvalidCommandContent.CMD	%s
400	InvalidCommandContent.ENTRYPOINT	%s
400	MissingParameter.Content	%s
400	EmptyCommandContent.RUN	%s.
400	EmptyCommandContent.ENV	%s.
400	EmptyCommandContent.LABEL	%s.
400	EmptyCommandContent.COPY	%s.
400	EmptyCommandContent.ENTRYPOINT	%s.
400	EmptyCommandContent.CMD	%s.
400	NotEmptyCommandContent.RESTART	%s.
400	EmptyCommandContent.WORKDIR	%s.
400	EmptyCommandContent.USER	%s.
400	QuotaExceed.ImageComponent	%s.
400	InvalidParameter.Content	%s.
400	InvalidImage.OsTypeUnsupported	The specified base image does not support image building.
400	InvalidParameter.ComponentVersion	The specified ComponentVersion is invalid.
403	InvalidComponentVersion.Exist	The specified ComponentVersion does exist with the specified Name.
403	InvalidOperation.NoPermissionCreateServiceLinkedRole	You are not authorized to create Service-linked role. The system will automatically create it when the API is called for the first time. Check your RAM policies, and ensure that you are using the correct credentials.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.
404	NotSupportedCommand.FROM	%s

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

変更履歴

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