CreateImagePipeline - - Alibaba Cloud ドキュメントセンター

説明

画像テンプレートを使用して、画像コンテンツをカスタマイズし、リージョンやアカウント間で画像を作成できます。この操作を呼び出すときは、次の項目に注意してください。

カスタム画像テンプレートのみ作成できます。
カスタムイメージテンプレートを作成するには、パブリック、カスタム、または共有Linuxイメージまたはイメージファミリーのみをソースイメージとして構成できます。
イメージテンプレートを使用してイメージを作成する場合、イメージの作成に役立つ中間のECS (Elastic Compute Service) インスタンスを作成する必要があります。中間インスタンスは従量課金で課金されます。詳細については、「従量課金」をご参照ください。

画像テンプレートのコンテンツを指定するBuildContentパラメーターでは、次の項目に注意してください。

BuildContent値にFROMコマンドが含まれている場合、ソースイメージのタイプを指定するBaseImageTypeおよびソースイメージを指定するBaseImageの値は、FROMコマンドによって上書きされます。
BuildContent値にFROMコマンドが含まれていない場合、BaseImageType値とBaseImage値で構成されるFROMコマンドがテンプレートコンテンツの最初の行に <BaseImageType >:< BaseImage> の形式で追加されます。
Dockerfileを使用して画像テンプレートのコンテンツを編集し、編集したコンテンツをBuildContentパラメーターに渡すことができます。コンテンツのサイズは16 KBを超えることはできず、最大127個のコマンドを含めることができます。サポートされているコマンドについては、「Image Builderでサポートされているコマンド」をご参照ください。

ECSコンソールでイメージコンポーネントを使用してイメージテンプレートを作成できますが、API操作を呼び出してイメージコンポーネントを使用してイメージテンプレートを作成することはできません。詳細については、「概要」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター


パラメーター	データ型	必須／任意	例	説明
操作	String	必須	CreateImagePipeline	実行する操作です。値をCreateImagePipelineに設定します。
RegionId	String	必須	cn-hangzhou	イメージテンプレートのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。
ResourceGroupId	String	任意	rg-bp67acfmxazb4p****	イメージテンプレートを割り当てるリソースグループのID。
BaseImageType	String	必須	画像	ソースイメージのタイプ。設定可能な値は以下のとおりです。画像: カスタム画像 IMAGE_FAMILY: イメージファミリー
ベースイメージ	String	必須	m-bp67acfmxazb4p****	ソースイメージ。 `BaseImageType`をIMAGEに設定したら、BaseImageをカスタムイメージのIDに設定します。 `BaseImageType`をIMAGE_FAMILYに設定した場合、BaseImageをイメージファミリの名前に設定します。
パラメーター名	String	任意	testImagePipeline	イメージテンプレートの名前。名前の長さは 2 から 128 文字です。文字で始める必要があり、`http://` または`https://` で始めることはできません。 It can contain letters, digits, colons (:), underscores (_), periods (.),and hyphens (-). 注 `Name`パラメーターを指定しない場合、デフォルトで`ImagePipelineId`の戻り値が使用されます。
説明	String	任意	これは説明です。	画像テンプレートの説明。説明の長さは 2 ~ 256 文字である必要があります。文頭に `http://` または `https://` を使用することはできません。
ImageName	String	任意	testImageName	作成するイメージの名前のプレフィックス。プレフィックスの長さは2 ~ 64文字である必要があります。文字で始める必要があり、`http://` または`https://` で始めることはできません。英数字、コロン (:) 、アンダースコア (_) 、ピリオド (.) 、ハイフン (-) を使用できます。プレフィックスとイメージビルドタスクのID (`ExecutionId`) で構成される最終的な完全イメージ名が `{ImageName }_{ ExecutionId}` の形式で生成されます。
VSwitchId	String	任意	vsw-bp67acfmxazb4p****	VSwitch の ID です。このパラメーターを指定しない場合、仮想プライベートクラウド (VPC) とvSwitchがデフォルトで作成されます。アカウントのVPCクォータが十分であることを確認してください。詳細については、「制限事項」をご参照ください。
InstanceType	String	任意	ecs.g6.large	インスタンスのインスタンスタイプ。 DescribeInstanceTypesを呼び出して、インスタンスタイプを照会できます。このパラメーターを指定しない場合、vCPUとメモリリソースが最も少ないインスタンスタイプが自動的に選択されます。この設定は、インスタンスタイプのリソース可用性の影響を受けます。たとえば、デフォルトではecs.g6.largeインスタンスタイプが選択されています。利用可能なecs.g6.largeリソースが不足している場合、ecs.g6.xlargeインスタンスタイプが選択されます。
SystemDiskSize	Integer	任意	40	中間インスタンスのシステムディスクのサイズ。単位: GiB。有効値：20〜500。デフォルト値: 40。
InternetMaxBandwidthOut	Integer	任意	0	中間インスタンスのアウトバウンドパブリック帯域幅のサイズ。単位：Mbit/秒有効値: 0~100。デフォルト値は 0 です。
DeleteInstanceOnFailure	Boolean	任意	true	イメージを作成できない場合に中間インスタンスをリリースするかどうかを指定します。設定可能な値は以下のとおりです。 true: イメージを作成できない場合、中間インスタンスをリリースします。 false: イメージを作成できない場合、中間インスタンスをリリースしません。 Default value: true. 注中間インスタンスを起動できない場合、インスタンスはデフォルトでリリースされます。
BuildContent	String	任意	画像から: m-bp67acfmxazb4p ****	画像テンプレートのコンテンツ。コンテンツのサイズは16 KBを超えることはできず、最大127個のコマンドを含めることができます。サポートされているコマンドの詳細については、このトピックの「説明」を参照してください。
ClientTokend	String	任意	123e4567-e89b-12d3-a456-426655440000	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 ClientToken値にはASCII文字のみを使用でき、長さは64文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。
Tag.N.Key	String	任意	TestKey	タグNのキー。Nの有効値: 1〜20。タグキーを空の文字列にすることはできません。長さは最大128文字で、`acs:` または`aliyun`で始めることはできません。 `http://` または`https://` は使用できません。
Tag.N.Value	String	任意	TestValue	タグNの値。Nの有効値: 1〜20。タグ値は、空の文字列が使用可能です。長さは 128 文字以内である必要があります。 `acs:` で始めることも、`http://` または`https://` を含めることもできません。
AddAccount.N	Long	任意	1234567890	作成されたイメージを共有するAlibaba CloudアカウントNのID。 N の有効値：1 ～ 20。
ToRegionId.N	String	任意	cn-hangzhou	作成された画像を配信する領域NのID。 N の有効値：1 ～ 20。このパラメーターを指定しない場合、イメージはデフォルトで現在のリージョンにのみ作成されます。

レスポンスパラメーター


パラメーター	データ型	例	説明
ImagePipelineId	String	ip-2ze5tsl5bp6nf2b3 ****	イメージテンプレートのID。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	リクエストの ID です。

例

リクエストの例

https://ecs.aliyuncs.com/?Action=CreateImagePipeline
&BaseImage=m-bp67acfmxazb4p ****
&BaseImageType=IMAGE
&RegionId=cn-hangzhou
&名前=testImagePipeline
&BuildContent=画像から: m-bp67acfmxazb4p ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateImagePipelineResponse>
    <RequestId> 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E </ RequestId>
    <ImagePipelineId>ip-2ze5tsl5bp6nf2b3 ****</ImagePipelineId>
</CreateImagePipelineResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E" 、
  "ImagePipelineId" : "ip-2ze5tsl5bp6nf2b3 ****"
}

エラーコード


HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidImage.NotFound	%s	指定されたパラメーターが無効な場合に返されるエラーメッセージです。詳細については、エラーメッセージの % sプレースホルダーの戻り値をご参照ください。
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	指定されたResourceGroupIdパラメーターが存在しない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。