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

1 つ以上のイメージテンプレートについて説明します。

操作説明

結果をページ分割して表示するには、NextToken パラメーターを前回の DescribeImagePipelines 応答の NextToken 値に設定し、MaxResults を使用してページあたりの結果数を制限します。

今すぐお試しください

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

get

*ImagePipeline

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

*ImagePipeline

acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。DescribeRegions 操作を呼び出して、最新の Alibaba Cloud リージョンを照会できます。	cn-hangzhou
ResourceGroupId	string	任意	エンタープライズリソースグループの ID。このパラメーターを使用してリソースをフィルター処理する場合、クエリは最大 1,000 個のリソースを返します。説明デフォルトのリソースグループでフィルター処理することはできません。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	タグのリスト。
	object	任意	タグオブジェクト。
Key	string	任意	タグ N のキー。最大 20 個のタグを指定できます。	TestKey
Value	string	任意	タグ N の値。最大 20 個のタグを指定できます。	TestValue
RegionId	string	必須	リージョン ID。DescribeRegions 操作を呼び出して、最新の Alibaba Cloud リージョンを照会できます。	cn-hangzhou
ResourceGroupId	string	任意	エンタープライズリソースグループの ID。このパラメーターを使用してリソースをフィルター処理する場合、クエリは最大 1,000 個のリソースを返します。説明デフォルトのリソースグループでフィルター処理することはできません。	rg-bp67acfmxazb4p****
Name	string	任意	イメージパイプラインの名前。	testImagePipeline
NextToken	string	任意	次のページの結果を取得するためのトークン。次のページを取得するには、このパラメーターを前の応答の NextToken 値に設定します。最初のリクエストでは、このパラメーターを省略します。	AAAAAdDWBF2****
MaxResults	integer	任意	ページごとに返すエントリの最大数。有効値：1～500。デフォルト値：50。	50
ImagePipelineId	array	任意	イメージパイプラインの ID。最大 20 個の ID を指定できます。	ip-2ze5tsl5bp6nf2b3****
	string	任意	イメージパイプラインの ID。	ip-2ze5tsl5bp6nf2b3****

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。詳細については、「注意事項」セクションをご参照ください。	AAAAAdDWBF2****
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	イメージテンプレートの総数。	1
MaxResults	integer	ページあたりのエントリ数。	50
ImagePipeline	object
ImagePipelineSet	array<object>	イメージテンプレートの詳細。
	array<object>
CreationTime	string	イメージテンプレートが作成された時間。	2020-11-24T06:00:00Z
DeleteInstanceOnFailure	boolean	イメージの作成に失敗した場合に中間インスタンスをリリースするかどうかを示します。	true
InstanceType	string	インスタンスタイプ。	ecs.g6.large
InternetMaxBandwidthOut	integer	中間インスタンスのパブリックアウトバウンド帯域幅。単位：Mbit/s。	0
ImagePipelineId	string	イメージテンプレートの ID。	ip-2ze5tsl5bp6nf2b3****
VSwitchId	string	vSwitch の ID。	vsw-bp67acfmxazb4p****
SystemDiskSize	integer	中間インスタンスのシステムディスクサイズ。単位：GiB。	40
Description	string	イメージテンプレートの説明。	This is description.
BaseImage	string	ソースイメージ。 `BaseImageType` が `IMAGE` に設定されている場合、このパラメーターの値はカスタムイメージの ID です。 `BaseImageType` が `IMAGE_FAMILY` に設定されている場合、このパラメーターの値はイメージファミリーの名前です。	m-bp67acfmxazb4p****
ResourceGroupId	string	リソースグループの ID。	rg-bp67acfmxazb4p****
ImageName `deprecated`	string	ターゲットイメージ名のプレフィックス。重要このパラメーターは非推奨です。代わりに `ImageOptions.ImageName` を使用してください。	testImageName
BaseImageType	string	ソースイメージのタイプ。有効値： IMAGE：カスタムイメージ IMAGE_FAMILY：イメージファミリー	IMAGE
Name	string	テンプレートの名前。	testImagePipeline
BuildContent	string	イメージテンプレートのコンテンツ。	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
Tags	object
Tag	array<object>	タグ。
	object
TagValue	string	タグの値。	TestValue
TagKey	string	タグのキー。	TestKey
ToRegionIds	object
ToRegionId	array	ターゲットリージョンの ID。
	string	ターゲットリージョンの ID。	["cn-hangzhou"]
AddAccounts	object
AddAccount	array	イメージを共有する Alibaba Cloud アカウントの ID。
	string	イメージを共有する Alibaba Cloud アカウントの ID。	["1234567890"]
RepairMode	string	イメージテンプレートの修復オプション。有効値： Standard：標準モード	Standard
TestContent	string	イメージテストテンプレートのコンテンツ。	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
ImageFamily `deprecated`	string	ターゲットイメージファミリーの名前。重要このパラメーターは非推奨です。代わりに `ImageOptions.ImageFamily` を使用してください。	family
NvmeSupport `deprecated`	string	ターゲットイメージが NVMe をサポートしているかどうかを示します。重要このパラメーターは非推奨です。代わりに `ImageOptions.ImageFeatures.NvmeSupport` を使用してください。	auto
ImportImageOptions	object	イメージをインポートするための属性と設定。
Architecture	string	システムアーキテクチャー。有効値： x86_64 arm64	x86_64
OSType	string	オペレーティングシステム。有効値： windows linux	linux
Platform	string	オペレーティングシステムのディストリビューション。有効値： Aliyun Anolis CentOS Ubuntu CoreOS SUSE Debian OpenSUSE FreeBSD RedHat Kylin UOS Fedora Fedora CoreOS CentOS Stream AlmaLinux Rocky Linux Gentoo Customized Linux Others Linux Windows Server 2022 Windows Server 2019 Windows Server 2016 Windows Server 2012 Windows Server 2008 Windows Server 2003 Other Windows	Aliyun
BootMode	string	イメージの起動モード。有効値： BIOS UEFI	BIOS
LicenseType	string	イメージのインポート後にオペレーティングシステムをアクティベートするために使用されるライセンスタイプ。有効値： Auto：Alibaba Cloud はソースイメージのオペレーティングシステムを検出し、ライセンスを割り当てます。このモードでは、システムはまず、`Platform` で指定されたオペレーティングシステムに対して公式の Alibaba Cloud ライセンスが利用可能かどうかを確認します。公式ライセンスが利用できない場合、システムは BYOL (Bring Your Own License) モードに切り替わります。 Aliyun：`Platform` で指定されたオペレーティングシステムに基づいて、公式の Alibaba Cloud ライセンスを使用します。 BYOL：ソースイメージのライセンスを使用します。BYOL モードを使用する場合、ライセンスが Alibaba Cloud でサポートされていることを確認してください。	Auto
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	カスタムイメージに関する情報。 N=1 はシステムディスクを示します。 N は 2 から 17 までの整数で、データディスクを示します。
	object
OSSBucket	string	イメージファイルが格納されている OSS バケット。	ecsimageos
OSSObject	string	OSS バケット内のイメージファイルの名前。	CentOS_5.4_32.raw
Format	string	イメージフォーマット。有効値： RAW VHD QCOW2	RAW
DiskImageSize	integer	イメージのインポート後のカスタムイメージのサイズ。サイズは、システムディスクサイズとデータディスクサイズで構成されます。システムディスクサイズがインポートされたイメージファイルのサイズ以上であることを確認する必要があります。有効値： N が 1 (システムディスク) の場合、値の範囲は 1～2,048 です。単位：GiB。 N が 2～17 の整数 (データディスク) の場合、値の範囲は 1～2,048 です。単位：GiB。ソースイメージファイルを OSS バケットにアップロードした後、OSS バケットでイメージファイルのサイズを表示できます。	40
Features	object	イメージの属性。
NvmeSupport	string	インポートされたイメージが NVMe をサポートしているかどうかを示します。有効値： supported：このイメージから作成されたインスタンスは NVMe プロトコルをサポートします。 unsupported：このイメージから作成されたインスタンスは NVMe プロトコルをサポートしません。	supported
ImdsSupport	string
RetainImportedImage	boolean	説明このパラメーターは招待プレビューです。	false
RetentionStrategy	string
ImageName	string
Description	string
RoleName	string
ImportImageTags	object
ImportImageTag	array<object>
	object
Key	string
Value	string
AdvancedOptions	object	詳細設定。
RetainCloudAssistant	boolean	Cloud Assistant を保持するかどうかを示します。ビルドプロセス中に、システムは中間インスタンスに Cloud Assistant を自動的にインストールしてコマンドを実行します。ターゲットイメージに Cloud Assistant を保持するかどうかを選択できます。有効値： true：Cloud Assistant を保持します。 false：Cloud Assistant を保持しません。説明この設定は、ソースイメージに含まれている Cloud Assistant クライアントには影響しません。	true
ImageNameSuffix	string	システムがターゲットイメージ名にサフィックスを自動的に追加するのを無効にするかどうかを示します。有効値： disable：システムがサフィックスを追加するのを無効にします。	disable
ImageOptions	object	ターゲットイメージの属性。
ImageName	string	ターゲットイメージ名のプレフィックス。	imageName
ImageFamily	string	ターゲットイメージファミリーの名前。	family
Description	string	ターゲットイメージの説明。	description.
ImageFeatures	object	ターゲットイメージの属性。
NvmeSupport	string	ターゲットイメージが NVMe をサポートしているかどうかを示します。有効値： supported：このイメージから作成されたインスタンスは NVMe プロトコルをサポートします。 unsupported：このイメージから作成されたインスタンスは NVMe プロトコルをサポートしません。 auto：システムは、ソースイメージに NVMe ドライバーがインストールされているかどうかを自動的に確認します。この確認は、ビルドフェーズの前に行われます。ビルド中に NVMe ドライバーがインストールまたはアンインストールされた場合、検出が不正確になる可能性があります。このような場合は、ビルドコンテンツに基づいてこのパラメーターを `supported` または `unsupported` に設定してください。	auto
ImageTags	object
ImageTag	array<object>	ターゲットイメージのタグ。
	object
TagKey	string	タグのキー。	testKey
TagValue	string	タグの値。	testValue

例

成功レスポンス

JSONJSON

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImagePipeline": {
    "ImagePipelineSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "DeleteInstanceOnFailure": true,
        "InstanceType": "ecs.g6.large",
        "InternetMaxBandwidthOut": 0,
        "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
        "VSwitchId": "vsw-bp67acfmxazb4p****",
        "SystemDiskSize": 40,
        "Description": "This is description.",
        "BaseImage": "m-bp67acfmxazb4p****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ImageName": "testImageName",
        "BaseImageType": "IMAGE",
        "Name": "testImagePipeline",
        "BuildContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "RepairMode": "Standard",
        "TestContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "ImageFamily": "family",
        "NvmeSupport": "auto",
        "ImportImageOptions": {
          "Architecture": "x86_64",
          "OSType": "linux",
          "Platform": "Aliyun",
          "BootMode": "BIOS",
          "LicenseType": "Auto",
          "DiskDeviceMappings": {
            "DiskDeviceMapping": [
              {
                "OSSBucket": "ecsimageos",
                "OSSObject": "CentOS_5.4_32.raw",
                "Format": "RAW",
                "DiskImageSize": 40
              }
            ]
          },
          "Features": {
            "NvmeSupport": "supported",
            "ImdsSupport": ""
          },
          "RetainImportedImage": false,
          "RetentionStrategy": "",
          "ImageName": "",
          "Description": "",
          "RoleName": "",
          "ImportImageTags": {
            "ImportImageTag": [
              {
                "Key": "",
                "Value": ""
              }
            ]
          }
        },
        "AdvancedOptions": {
          "RetainCloudAssistant": true,
          "ImageNameSuffix": "disable"
        },
        "ImageOptions": {
          "ImageName": "imageName",
          "ImageFamily": "family",
          "Description": "description.",
          "ImageFeatures": {
            "NvmeSupport": "auto"
          },
          "ImageTags": {
            "ImageTag": [
              {
                "TagKey": "testKey",
                "TagValue": "testValue"
              }
            ]
          }
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidImagePipelineIdSize.ExceededMaxNumber	%s
400	InvalidName.Malformed	%s
403	Invalid.NextToken	The specified NextToken is not valid.

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

変更履歴

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