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

1 つ以上のイメージテンプレートの詳細を照会します。

操作説明

NextToken には、前回 DescribeImagePipelines を呼び出したときに返された NextToken の値をセットし、MaxResults を使用して 1 ページあたりの最大エントリ数を指定できます。

今すぐお試しください

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

*イメージパイプライン回線。

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

*イメージパイプライン回線。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ResourceGroupId	string	任意	エンタープライズリソースグループの ID。このパラメーターを使用してリソースをフィルター処理する場合、リソース数は 1,000 を超えることはできません。説明デフォルトのリソースグループによるフィルター処理はサポートされていません。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	タグキー。N の有効な値: 1 ~ 20。	TestKey
Value	string	任意	タグ値。N の有効な値: 1 ~ 20。	TestValue
Name	string	任意	テンプレート名。	testImagePipeline
NextToken	string	任意	ページネーショントークン。このパラメーターには、前の呼び出しで返された NextToken の値を設定します。最初のリクエストでは、このパラメーターを設定する必要はありません。	AAAAAdDWBF2****
MaxResults	integer	任意	ページングクエリにおける 1 ページあたりのエントリの最大値。有効な値: 1 ~ 500。デフォルト値: 50。	50
ImagePipelineId	array	任意	イメージテンプレート ID。N の有効な値: 1 ~ 20。	ip-2ze5tsl5bp6nf2b3****
	string	任意	イメージテンプレート ID。N の有効な値: 1 ~ 20。	ip-2ze5tsl5bp6nf2b3****

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	この呼び出しで返されるページネーショントークン。このトークンの使用方法については、操作の説明を参照してください。	AAAAAdDWBF2****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返されるイメージテンプレートの総数。	1
MaxResults	integer	ページングクエリにおける 1 ページあたりのエントリの最大数。	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	VPC の vSwitch ID。	vsw-bp67acfmxazb4p****
SystemDiskSize	integer	中間インスタンスのシステムディスクサイズ。単位: GiB。	40
Description	string	説明。	これは説明です
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**:イメージcomponent/ComponentName/1..*
Tags	object
Tag	array<object>	タグキーと値のペア。
	object
TagValue	string	タグ値。	TestValue
TagKey	string	タグキー	TestKey
ToRegionIds	object
ToRegionId	array	送信先イメージが分散されるリージョン。
	string	送信先イメージが分散されるリージョン。	["cn-hangzhou"]
AddAccounts	object
AddAccount	array	送信先イメージのイメージ共有用の Alibaba Cloud アカウント ID。
	string	送信先イメージのイメージ共有用の Alibaba Cloud アカウント ID。	["1234567890"]
RepairMode	string	イメージテンプレートの修復オプション。有効な値: Standard: 標準修復モード。 Linux 用の標準修復パッケージには以下が含まれます: GUESTOS.CloudInit GUESTOS.Dhcp GUESTOS.Virtio GUESTOS.OnlineResizeFS GUESTOS.Grub GUESTOS.Fstab GUESTOS.Nvme Windows 用の標準修復パッケージには以下が含まれます: GUESTOS.Virtio GUESTOS.Update GUESTOS.Hotfix GUESTOS.Server GUESTOS.Bcd GUESTOS.Disk GUESTOS.Bootmgr GUESTOS.OSLoader GUESTOS.Vminit All: 完全修復モード。 Linux 用の完全修復パッケージには、標準修復パッケージのすべての項目に加えて以下が含まれます: GUESTOS.Selinux GUESTOS.SecurityCenterAgent Windows 用の完全修復パッケージには、標準修復パッケージのすべての項目に加えて以下が含まれます: GUESTOS.Server Customized: カスタム修復モード。このモードでは、修復パッケージ内の修復項目は RepairItem パラメーターによって指定されます。説明検出および修復機能が継続的に改善されるにつれて、追加の修復項目が追加される場合があります。修復項目の詳細については、イメージ検出のビューを参照してください。	標準
RepairItems	object
RepairItem	array	イメージ修復項目。 Linux でサポートされている修復項目: fstab: ディスクマウント設定の問題を修復します。 grub: GRUB ブート設定の問題を修復します。 dhcp: ネットワーク DHCP の問題を修復します。 selinux: Security-Enhanced Linux の問題を修復します。 growpart: ルートパーティションのオンライン自動拡張の問題を修復します。 cloudinit: cloud-init 初期化サービスをインストールします。 aegis: セキュリティセンターエージェントサービスをインストールします。 nvme: NVMe ドライバーの問題を修復します。 virtio: virtio ドライバーの問題を修復します。 standardizedtimezone: 標準化された時間ゾーンの問題を修復します。 Windows でサポートされている修復項目: bcd: ブート構成データファイルの問題を修復します。 hotfix: Windows 修正プログラムの問題を修復します。 disk: ディスクセットの問題を修復します。 update: Update プロセスの問題を修復します。 server: サーバー設定の問題を修復します。 bootmgr: Windows ブートマネージャーの問題を修復します。 vminit: Windows 初期化エージェントの問題を修復します。 osloader: Windows OS ローダーの問題を修復します。 virtio: virtio ドライバーの問題を修復します。 standardizedtimezone: 標準化された時間ゾーンの問題を修復します。
	string
TestContent	string	イメージテストテンプレートの内容。	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:イメージcomponent/ComponentName/1..*
ImageFamily `deprecated`	string	送信先イメージのイメージファミリー。重要このパラメーターは非推奨です。代わりに ImageOptions.ImageFamily を使用してください。	インスタンスファミリー
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: BIOS ブートモード。 UEFI: 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 バケット。	ecsイメージos
OSSObject	string	イメージのアップロード後に OSS バケットに保存されるイメージファイルのファイル名 (キー)。	CentOS_5.4_32.raw
Format	string	イメージの初期化。有効な値: RAW。 VHD。 QCOW2。	RAW
DiskImageSize	integer	インポート後のカスタムイメージのサイズ。サイズはシステムディスクとデータディスクで構成されます。システムディスクサイズは、インポートされたイメージファイルのサイズ以上である必要があります。有効な値: N=1 の場合、エントリはシステムディスクを表します。有効な値: 1 GiB ~ 2048 GiB。 N=2 ~ 17 の場合、エントリはデータディスクを表します。有効な値: 1 GiB ~ 2048 GiB。ソースイメージファイルを OSS にアップロードした後、OSS バケットでイメージファイルのサイズをビューできます。	40
Features	object	イメージの特徴のプロパティ。
NvmeSupport	string	インポートされたイメージが NVMe をサポートしているかどうかを示します。有効な値: supported: サポートされています。このイメージから作成されたインスタンスは NVMe プロトコルをサポートします。 unsupported: サポートされていません。このイメージから作成されたインスタンスは NVMe プロトコルをサポートしません。	supported
ImdsSupport	string	イメージのメタデータアクセスモード。有効な値: v1: このイメージから ECS インスタンスを作成する場合、メタデータアクセスモードを IMDSv2 のみ (強化モード) に設定することはできません。 v2: このイメージから ECS インスタンスを作成する場合、メタデータアクセスモードを IMDSv2 のみ (強化モード) に設定できます。デフォルト値: v1。	v2
RetainImportedImage	boolean	重要このパラメーターは非推奨です。代わりに ImportImageOptions.RetentionStrategy を使用してください。	false
RetentionStrategy	string	インポートされたイメージのデータ保持ポリシー。有効な値: RetainOnlySuccessful: ビルドが成功した場合にのみイメージを保持します。 RetainOnlyFailed: ビルドが失敗した場合にのみイメージを保持します。 RetainAlways: ビルド結果に関係なく、常にイメージを保持します。 RetainNever: ビルド結果に関係なく、イメージを保持しません。デフォルト値: RetainNever。	RetainAlways
ImageName	string	インポートされたイメージの名前。	fvt-ecs-インポート-イメージ-1812b2d7
Description	string	インポートされたイメージの説明。	created by acc
RoleName	string	イメージのインポート時に使用される RAM ロール名。	AliyunECSImageImportDefaultRole
ImportImageTags	object
ImportImageTag	array<object>
	object
Key	string	イメージのタグキー。	testKey
Value	string	イメージのタグ値。	testValue
AdvancedOptions	object	詳細設定。
RetainCloudAssistant	boolean	クラウドアシスタントを保持するかどうかを示します。ビルドプロセス中に、システムはコマンドを呼び出して実行するために中間インスタンスにクラウドアシスタントを自動的にインストールします。送信先イメージにクラウドアシスタントを保持するかどうかを選択できます。有効な値: true: 保持します。 false: 保持しません。説明この設定は、イメージにすでに含まれているクラウドアシスタントには影響しません。	true
ImageNameSuffix	string	送信先イメージ名の自動サフィックスが無効になっているかどうかを示します。有効な値: disable: 無効。	disable
ImageOptions	object	送信先イメージのプロパティ。
ImageName	string	送信先イメージ名のプレフィックス。	イメージ名
ImageFamily	string	送信先イメージのイメージファミリー。	インスタンスファミリー
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*****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue。",
              "TagKey": "TestKey。"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "RepairMode": "標準",
        "RepairItems": {
          "RepairItem": [
            ""
          ]
        },
        "TestContent": "COMPONENT ic-bp12dvdzvr9k9*****",
        "ImageFamily": "インスタンスファミリー",
        "NvmeSupport": "auto。",
        "ImportImageOptions": {
          "Architecture": "x86_64",
          "OSType": "linux。",
          "Platform": "Aliyun。",
          "BootMode": "BIOS。",
          "LicenseType": "Auto。",
          "DiskDeviceMappings": {
            "DiskDeviceMapping": [
              {
                "OSSBucket": "イメージ",
                "OSSObject": "CentOS_5.4_32.raw。",
                "Format": "RAW。",
                "DiskImageSize": 40
              }
            ]
          },
          "Features": {
            "NvmeSupport": "supported。",
            "ImdsSupport": "v2"
          },
          "RetainImportedImage": true,
          "RetentionStrategy": "RetainAlways",
          "ImageName": "fvt-ecs-imported-image-1812b2d7",
          "Description": "created by acc",
          "RoleName": "AliyunECSImageImportDefaultRole",
          "ImportImageTags": {
            "ImportImageTag": [
              {
                "Key": "testKey",
                "Value": "testValue"
              }
            ]
          }
        },
        "AdvancedOptions": {
          "RetainCloudAssistant": true,
          "ImageNameSuffix": "disable。"
        },
        "ImageOptions": {
          "ImageName": "イメージ",
          "ImageFamily": "インスタンスファミリー",
          "Description": "description.",
          "ImageFeatures": {
            "NvmeSupport": "auto。"
          },
          "ImageTags": {
            "ImageTag": [
              {
                "TagKey": "testKey。",
                "TagValue": "testValue。"
              }
            ]
          }
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidImagePipelineIdSize.ExceededMaxNumber	%s	指定された ImagePipelineId.N の数が上限を超えています。N の値は 1 から 20 の有効値である必要があります。
400	InvalidName.Malformed	%s
403	Invalid.NextToken	The specified NextToken is not valid.

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

変更履歴

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