イメージテンプレートを作成します。イメージテンプレートを使用してイメージを構築できます。
操作説明
操作の説明。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:CreateImagePipeline |
create |
*ImagePipeline
|
なし |
|
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Tag |
array<object> |
任意 |
タグ。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
タグキー。N の有効な値: 1~20。タグキーは空文字列にできません。タグキーの長さは最大 128 文字で、 |
TestKey。 |
| Value |
string |
任意 |
タグ値。N の有効な値: 1~20。タグ値は空文字列にできます。タグ値の長さは最大 128 文字で、 |
TestValue。 |
| RegionId |
string |
必須 |
リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou。 |
| ResourceGroupId |
string |
任意 |
エンタープライズリソースグループの ID。 |
rg-bp67acfmxazb4p**** |
| AddAccount |
array |
任意 |
イメージ共有を通じて送信先イメージを共有する Alibaba Cloud アカウントの ID。N の有効な値: 1~20。 |
1234567890 |
|
integer |
任意 |
イメージ共有を通じて送信先イメージを共有する Alibaba Cloud アカウントの ID。N の有効な値: 1~20。 |
1234567890 |
|
| ToRegionId |
array |
任意 |
送信先イメージを配布するリージョン。N の有効な値: 1~20。 |
cn-hangzhou。 |
|
string |
任意 |
送信先イメージを配布するリージョン。N の有効な値: 1~20。 |
cn-hangzhou。 |
|
| RepairItem |
array |
任意 |
||
|
string |
任意 |
|||
| BaseImageType |
string |
必須 |
ソースイメージのタイプ。有効な値: |
IMAGE。 |
| BaseImage |
string |
任意 |
ソースイメージ。 |
m-bp67acfmxazb4p**** |
| Name |
string |
任意 |
テンプレート名。名前の長さは 2~128 文字で、英字または漢字で始まる必要があります。名前は |
testImagePipeline。 |
| Description |
string |
任意 |
説明。説明の長さは 2~256 文字で、 |
This is description. |
ImageName
deprecated
|
string |
任意 |
送信先イメージ名のプレフィックス。 |
testImageName。 |
| VSwitchId |
string |
任意 |
VPC の vSwitch ID。 |
vsw-bp67acfmxazb4p**** |
| InstanceType |
string |
任意 |
インスタンスタイプ。 DescribeInstanceTypes を呼び出して、利用可能なインスタンスタイプをクエリできます。 |
ecs.g6.large。 |
| SystemDiskSize |
integer |
任意 |
中間インスタンスのシステムディスクサイズ。単位: GiB。有効な値: 20~500。 |
40 |
| InternetMaxBandwidthOut |
integer |
任意 |
中間インスタンスのアウトバウンドパブリック帯域幅。単位: Mbit/s。有効な値: 0~100。 |
0 |
| DeleteInstanceOnFailure |
boolean |
任意 |
イメージ構築が失敗した場合に中間インスタンスをリリースするかどうかを指定します。有効な値: |
true。 |
| BuildContent |
string |
任意 |
イメージ構築テンプレートのコンテンツ。コンテンツサイズは 16 KB 以下にする必要があります。サポートされているコマンドの詳細については、「Image Builder でサポートされるコマンド」を参照してください。 |
COMPONENT ic-bp12dvdzvr9k9***** |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken の値には ASCII 文字のみを使用でき、長さは 64 文字以下にする必要があります。詳細については、「べき等性を確保する方法」を参照してください。 |
123e4567-e89b-12d3-a456-426655440000 |
| RepairMode |
string |
任意 |
イメージテンプレート内の修復オプション。 |
Standard。 |
ImageFamily
deprecated
|
string |
任意 |
送信先イメージファミリー。 |
インスタンスファミリー |
| TestContent |
string |
任意 |
イメージテストテンプレートのコンテンツ。コンテンツサイズは 16 KB 以下にする必要があります。サポートされているコマンドの詳細については、「Image Builder でサポートされるコマンド」を参照してください。 |
COMPONENT ic-bp12dvdzvr9k9***** |
| ImportImageOptions |
object |
任意 |
イメージをインポートするためのプロパティと設定。このパラメーターは |
|
| Architecture |
string |
任意 |
システムディスクのシステムアーキテクチャー。データディスクのスナップショットを使用してシステムディスクイメージを作成する場合、このパラメーターを指定する必要があります。有効な値: |
x86_64 |
| OSType |
string |
任意 |
オペレーティングシステムのタイプ。有効な値: |
linux。 |
| Platform |
string |
任意 |
オペレーティングシステムのバージョン。有効な値: |
Aliyun。 |
| BootMode |
string |
任意 |
イメージのブートモード。有効な値: |
BIOS。 |
| LicenseType |
string |
任意 |
イメージのインポート後にオペレーティングシステムをアクティブ化するために使用されるライセンスタイプ。有効な値: |
Auto。 |
| DiskDeviceMappings |
array<object> |
任意 |
カスタムイメージに関する情報。 |
|
|
object |
任意 |
|||
| OSSBucket |
string |
任意 |
イメージファイルが保存されている OSS バケット。 |
イメージ |
| OSSObject |
string |
任意 |
イメージのアップロード後に OSS バケットに保存されたイメージファイルの名前 (キー)。 |
CentOS_5.4_32.raw。 |
| Format |
string |
任意 |
イメージの初期化。有効な値: |
RAW。 |
| DiskImageSize |
integer |
任意 |
イメージのインポート後のカスタムイメージのサイズ。 |
40 |
| Features |
object |
任意 |
イメージの特徴プロパティ。 |
|
| NvmeSupport |
string |
任意 |
インポートされたソースイメージが NVMe をサポートするかどうかを指定します。有効な値: |
supported。 |
| ImdsSupport |
string |
任意 |
||
| RetainImportedImage |
boolean |
任意 |
説明
このパラメーターは招待プレビュー中です。 |
false。 |
| RetentionStrategy |
string |
任意 |
||
| ImageName |
string |
任意 |
||
| Description |
string |
任意 |
||
| RoleName |
string |
任意 |
||
| ImportImageTags |
array<object> |
任意 |
||
|
object |
任意 |
|||
| Key |
string |
任意 |
||
| Value |
string |
任意 |
||
NvmeSupport
deprecated
|
string |
任意 |
送信先イメージが NVMe をサポートするかどうかを指定します。 |
auto。 |
| AdvancedOptions |
object |
任意 |
詳細設定。 |
|
| RetainCloudAssistant |
boolean |
任意 |
クラウドアシスタントを保持するかどうかを指定します。構築プロセス中に、システムはコマンドを実行するために中間インスタンスにクラウドアシスタントを自動的にインストールします。送信先イメージにクラウドアシスタントを保持するかどうかを選択できます。有効な値: |
true。 |
| ImageNameSuffix |
string |
任意 |
送信先イメージ名の自動サフィックスを無効にするかどうかを指定します。有効な値: |
disable。 |
| ImageOptions |
object |
任意 |
送信先イメージのプロパティ。 |
|
| ImageName |
string |
任意 |
送信先イメージ名のプレフィックス。名前の長さは 2~64 文字で、英字または漢字で始まる必要があります。名前は |
testImageName。 |
| ImageFamily |
string |
任意 |
送信先イメージ ファミリー。名前の長さは 2~128 文字で、英字または漢字で始まる必要があります。名前は aliyun または acs: で始めることはできません。名前に http:// または https:// を含めることはできません。名前には、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。 |
family |
| Description |
string |
任意 |
説明。説明の長さは 2~256 文字で、 |
This is description. |
| ImageFeatures |
object |
任意 |
送信先イメージの特徴プロパティ。 |
|
| NvmeSupport |
string |
任意 |
送信先イメージが NVMe をサポートするかどうかを指定します。有効な値: |
auto。 |
| ImageTags |
array<object> |
任意 |
送信先イメージのタグ。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
タグキー。N の有効な値: 1~20。タグキーは空文字列にできません。タグキーの長さは最大 128 文字で、 |
TestKey。 |
| Value |
string |
任意 |
タグ値。N の有効な値: 1~20。タグ値は空文字列にできます。タグ値の長さは最大 128 文字で、 |
TestValue。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| ImagePipelineId |
string |
イメージテンプレートの ID。 |
ip-2ze5tsl5bp6nf2b3**** |
| RequestId |
string |
リクエスト ID |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
例
成功レスポンス
JSONJSON
{
"ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidSourceInstance.NotFound | The specified source instance is not found. | 指定されたソースインスタンスが見つかりませんでした。 |
| 400 | InvalidName.Malformed | %s | |
| 400 | InvalidDescription.Malformed | %s | |
| 400 | InvalidImageName.Malformed | %s | |
| 400 | InvalidBaseImageType.NotSupportedValue | %s | |
| 400 | InvalidSystemDiskSize.NotSupportedValue | %s | |
| 400 | InvalidInternetMaxBandwidthOut.NotSupportedValue | %s | |
| 400 | InvalidAddAccountSize.ExceededMaxNumber | %s | |
| 400 | InvalidToRegionIdSize.ExceededMaxNumber | %s | |
| 400 | InvalidBuildContent.LengthExceeded | %s | |
| 400 | InvalidImageTemplateCommandSize.ExceededMaxNumber | %s | |
| 400 | DuplicatedCommand.FROM | %s | |
| 400 | InvalidCommandOrder.FROM | %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.FROM | %s | |
| 400 | InvalidCommandContent.CMD | %s | |
| 400 | InvalidCommandContent.ENTRYPOINT | %s | |
| 400 | QuotaExceed.ImagePipeline | %s. | このリージョンにおける現在のユーザーのイメージテンプレートクォータが上限に達しています。 |
| 400 | NoPermission | %s. | この操作は許可されていません。続行する前に操作を承認してください。 |
| 400 | EmptyCommandContent.LABEL | %s. | テンプレートコンテンツに LABEL が含まれている場合、LABEL 値を空にすることはできません。 |
| 400 | EmptyCommandContent.ENV | %s. | テンプレートコンテンツに ENV が含まれている場合、ENV 値を空にすることはできません。 |
| 400 | EmptyCommandContent.ENTRYPOINT | %s. | テンプレートコンテンツに ENTRYPOINT が含まれている場合、ENTRYPOINT 値を空にすることはできません。 |
| 400 | EmptyCommandContent.CMD | %s. | テンプレートコンテンツに CMD コマンドが含まれている場合、CMD 値を空にすることはできません。 |
| 400 | EmptyCommandContent.COPY | %s. | テンプレートコンテンツに COPY コマンドが含まれている場合、COPY 値を空にすることはできません。 |
| 400 | EmptyCommandContent.WORKDIR | %s. | テンプレートコンテンツに WORKDIR コマンドが含まれている場合、WORKDIR 値を空にすることはできません。 |
| 400 | NotEmptyCommandContent.RESTART | %s. | テンプレートコンテンツに RESTART コマンドが含まれている場合、RESTART の値は空である必要があります。 |
| 400 | EmptyCommandContent.USER | %s. | テンプレートコンテンツに USER コマンドが含まれている場合、USER 値を空にすることはできません。 |
| 400 | EmptyCommandContent.RUN | %s. | RUN コマンドを空にすることはできません。 |
| 400 | InvalidImage.OsTypeUnsupported | The specified base image does not support image building. | 指定されたベースイメージのオペレーティングシステムはイメージ構築をサポートしていません。 |
| 400 | InvalidParameter.BuildContent | %s. | ビルドテンプレートの内容が有効ではありません。 |
| 400 | InvalidParameter.TestContent | %s. | テストテンプレートの内容が無効です。 |
| 400 | InvalidImageComponent.NotSupported | %s. | 指定されたイメージコンポーネントは利用できません。 |
| 400 | InvalidParameterCombination | %s. | パラメーターの組み合わせが無効です。 |
| 400 | InvalidParameter.RepairMode | The specified parameter RepairMode is invalid. | 指定された修復モードが無効です。 |
| 400 | InvalidImageFamily.Malformed | The format of the specified image family is invalid. | 指定されたイメージファミリーの形式が無効です。 |
| 400 | InvalidImage.ImageOwnerAliasUnsupported | The specified base image does not support distributing. | 指定されたベースイメージはディストリビューションをサポートしていません。 |
| 400 | InvalidParameter.ImportImageOptionsArchitecture | The specified parameter ImportImageOptions.Architecture is invalid. The correct value should be in [%s]. | 指定された ImportImageOptionsArchitecture パラメーターが無効です。有効な値については、エラーメッセージまたはドキュメントを参照してください。 |
| 400 | InvalidParameter.ImportImageOptionsOSType | The specified parameter ImportImageOptions.OSType is invalid. The correct value should be in [%s]. | 指定されたパラメーター ImportImageOptions.OSType が無効です。有効な値については、エラーメッセージまたはドキュメントを参照してください。 |
| 400 | InvalidParameter.ImportImageOptionsBootMode | The specified parameter ImportImageOptions.BootMode is invalid. The correct value should be in [%s]. | 指定された ImportImageOptions.BootMode パラメーターが無効です。有効な値については、エラーメッセージまたはドキュメントを参照してください。 |
| 400 | InvalidImportImageOptionsDiskDeviceMappings.LengthLimitExceeded | The length of the specified parameter ImportImageOptions.DiskDeviceMappings exceeds the limit(17). | 指定された ImportImageOptions.DiskDeviceMappings の長さが制限を超えています。最大値は 17 です。 |
| 400 | InvalidParameter.ImportImageOptionsDiskDeviceMappingsOSSObject | The specified parameter ImportImageOptions.DiskDeviceMappings.OSSObject is invalid. OSSObject supports up to 1023 characters, and cannot start with http:// or https://. | 指定された ImportImageOptions.DiskDeviceMappings.OSSObject パラメーターが正しくありません。値は最大 1023 文字で、"http://" または "https://" で開始することはできません。 |
| 400 | InvalidParameter.ImportImageOptionsDiskDeviceMappingsOSSBucket | The specified parameter ImportImageOptions.DiskDeviceMappings.OSSBucket is invalid. OSSBucket supports up to 63 characters, only lowercase letters, numbers, and dashes are allowed, and cannot start or end with a dash. | 指定された ImportImageOptionsDiskDeviceMappingsOSSBucket パラメーターのフォームが正しくありません。値は最大 63 文字で、小文字、数字、ハイフン (-) のみを含めることができます。ハイフン (-) で開始または終了することはできません。 |
| 400 | InvalidParameter.ImportImageOptionsPlatform | The specified parameter ImportImageOptions.Platform is invalid. The correct value should be in [%s]. | 指定されたパラメーター ImportImageOptions.Platform が無効です。有効な値については、エラーメッセージまたはドキュメントを参照してください。 |
| 400 | InvalidParameter.ImportImageOptionsLicenseType | The specified parameter ImportImageOptions.LicenseType is invalid. The correct value should be in [%s]. | 指定されたパラメーター ImportImageOptions.LicenseType が無効です。有効な値については、エラーメッセージまたはドキュメントを参照してください。 |
| 400 | InvalidParameter.ImportImageOptionsFeaturesNvmeSupport | The specified parameter ImportImageOptions.Features.NvmeSupport is invalid. The correct value should be in [%s]. | 指定されたパラメーター ImportImageOptions.Features.NvmeSupport が無効です。有効な値については、エラーメッセージまたはドキュメントを参照してください。 |
| 400 | InvalidParameter.NvmeSupport | The specified parameter NvmeSupport is invalid. The correct value should be in [%s]. | 指定された NvmeSupport パラメーターが無効です。有効な値については、エラーメッセージまたはドキュメントを参照してください。 |
| 400 | InvalidParameter.ImportImageOptionsDiskDeviceMappingsFormat | The specified parameter ImportImageOptions.DiskDeviceMappings.Format is invalid. The correct value should be in [%s]. | 指定された ImportImageOptions.DiskDeviceMappings.Format パラメーターが無効です。有効な値については、エラーメッセージまたはドキュメントを参照してください。 |
| 400 | InvalidOperation.DiskImageSizeExceeded | The disk size exceeds the limit. Please check the specified parameter ImportImageOptions.DiskDeviceMappings.DiskImageSize and ImportImageOptions.DiskDeviceMappings.OSSObject. Ensure that each of them is between 1 and 2048 in size. | ディスクサイズが上限を超えています。ImportImageOptions.DiskDeviceMappings.DiskImageSize および ImportImageOptions.DiskDeviceMappings.OSSObject パラメーターを確認し、サイズが 1〜2048 GB の範囲内であることを確認してください。 |
| 400 | InvalidImageOptions.Description | The specified parameter ImageOptions.Description is invalid. The length should be between 2 to 256 characters, and cannot start with http:// or https://. | 指定された ImageOptions.Description パラメーターが無効です。パラメーター値の長さは 2~256 文字である必要があり、http:// または https:// で始めることはできません。 |
| 400 | InvalidImageName.Duplicated | The specified image name is already in use in the target region. Please try a different one. | 指定されたイメージ名は既に使用されています。 |
| 400 | InvalidImage.NotSupportRepair | The specified base image does not support repair. | 指定されたベースイメージは修復をサポートしていません。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | タグに重複キーが存在します。キーを一意にしてください。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.N.Key is not valid. Tag keys cannot be empty or null, support up to 128 characters, cannot start with "aliyun" or "acs:", and cannot contain "http://" or "https://". | 指定されたタグキーが無効です。タグキーは空または null にできず、最大 128 文字まで指定可能で、"aliyun" または "acs:" で始まることはなく、"http://" または "https://" を含むことはできません。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.N.Value is not valid. Tag values support up to 128 characters, and cannot contain "http://" or "https://". | 指定されたタグ値が無効です。タグ値は最大 128 文字まで指定可能で、"http://" または "https://" を含むことはできません。 |
| 400 | InvalidAdvancedOptions.ImageNameSuffix | The specified parameter AdvancedOptions.ImageNameSuffix is invalid. The correct value should be in [%s]. | 指定されたパラメーター AdvancedOptions.ImageNameSuffix が無効です。有効な値についてはエラーメッセージを参照してください。 |
| 400 | InvalidImportImageOptions.DockerOptionsImageMalformed | The specified parameter ImportImageOptions.DockerOptions.Image is invalid. The length should be between 1 to 512 characters. | 指定された Docker イメージの長さは 1 ~ 512 文字である必要があります。 |
| 400 | InvalidImportImageOptions.DockerOptionsImageSizeMalformed | The specified parameter ImportImageOptions.DockerOptions.ImageSize is invalid. The size should be between 1GB to 2048GB. | 指定された Docker イメージのサイズは 1 GB ~ 2048 GB である必要があります。 |
| 403 | ImagePipeline.NotSupportWindowsInstance | Image pipeline does not support windows instance at this time. | |
| 403 | InvalidOSSObject.NotAuthorized | The specified ImportImageOptions.DiskDeviceMappings.OSSObject is not allowed to be accessed. | 指定された ImportImageOptions.DiskDeviceMappings.OSSObject へのアクセスは許可されていません。 |
| 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. | サービスリンクロールを作成する権限がありません。この操作を初めて呼び出す際、システムがサービスリンクロールを自動作成します。RAM アクセスポリシーを確認し、正しいアクセス認証情報を使用してポリシーが関連付けられていることを確認してください。 |
| 403 | InvalidOSSObject.NeedRestore | The specified ImportImageOptions.DiskDeviceMappings.OSSObject is an archived object and needs to be restored first. | 指定された ImportImageOptions.DiskDeviceMappings.OSSObject はアーカイブ済みオブジェクトです。先に解凍する必要があります。 |
| 403 | InvalidOperation.NoRightAccessOSS | ECS service is not authorized to access your OSS. Check your RAM roles and policies, and ensure that ecs.aliyuncs.com is authorized to assume AliyunECSImageImportDefaultRole. | ECS に OSS へのアクセス権限がありません。RAM ロールとポリシーを確認し、「ecs.aliyuncs.com」に「AliyunECSImageImportDefaultRole」ロールを偽装する権限が付与されていることを確認してください。 |
| 403 | InvalidOperation.OSSObjectIsImporting | The specified ImportImageOptions.DiskDeviceMappings.OSSObject is importing. | 指定された ImportImageOptions.DiskDeviceMappings.OSSObject はインポート中です。 |
| 404 | InvalidImage.NotFound | %s | |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | 対応するリソースグループが見つかりません。 |
| 404 | ImageComponent.NotFound | %s. | 指定されたイメージコンポーネント ID が見つかりませんでした。 |
| 404 | InvalidInstanceType.NotFound | The specified instance type does not exist. | 指定された InstanceType が存在しません。 |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitchId does not exist. | 指定された vSwitch が存在しません。 |
| 404 | InvalidRegionId.NotFound | %s | リージョン情報が無効です。 |
| 404 | InvalidImportImageOptionsDiskDeviceMappingsOSSObject.NotFound | The specified ImportImageOptions.DiskDeviceMappings.OSSObject is not found in this region. | 指定された ImportImageOptions.DiskDeviceMappings.OSSObject が現在のリージョンで見つかりませんでした。 |
| 404 | MissingParameter.RepairMode | The specified parameter RepairMode is missing. | 必須パラメーター RepairMode が指定されていません。 |
| 404 | MissingParameter.ImportImageOptions | The specified parameter ImportImageOptions is missing. | 指定された ImportImageOptions パラメーターが不足しています。 |
| 404 | MissingParameter.ImportImageOptionsDiskDeviceMappingsOSSObject | The specified parameter ImportImageOptions.DiskDeviceMappings.OSSObject is missing. | 必須パラメーター ImportImageOptions.DiskDeviceMappings.OSSObject が指定されていません。 |
| 404 | MissingParameter.ImportImageOptionsDiskDeviceMappingsOSSBucket | The specified parameter ImportImageOptions.DiskDeviceMappings.OSSBucket is missing. | 指定された ImportImageOptions.DiskDeviceMappings.OSSBucket パラメーターが不足しています。 |
| 404 | MissingParameter.ImageOptionsDiskDeviceMappings | The specified parameter ImportImageOptions.DiskDeviceMappings is missing. | ImportImageOptions.DiskDeviceMappings パラメーターが指定されていません。 |
| 404 | MissingImportImageOptions.DockerOptions | The specified parameter ImportImageOptions.DockerOptions is missing. | 指定されたパラメーター ImportImageOptions.DockerOptions がありません。 |
| 404 | InvalidOssBucketName.NotFound | The specified parameter OssDeliveryConfig.BucketName does not exist. | 指定された OSS バケットが存在しません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。