edit-icon download-icon

DescribeImages

最終更新日: Jul 04, 2018

説明

利用可能なイメージを照会します。このインターフェイスを呼び出すときは、次の点を考慮してください。

  • 表示されたイメージリソースリストには、カスタムイメージ、Alibaba Cloud によって提供されるパブリックイメージ、および他の Alibaba Cloud ユーザーから共有されたイメージが含まれています。

  • ページごとの照会をサポートします。クエリの結果には、使用可能なイメージリソースの総数と、現在のページ上のイメージリソースが含まれます。デフォルトでは、1 ページに 10 個の結果が表示されます。

リクエストパラメーター

名前 必須かどうか 説明
Action String はい このインタフェースの名前。値: DescribeImages
RegionId String はい インスタンスが属するリージョンの ID。DescribeRegions を呼び出して最新のリージョンリストを取得してください。
ImageId String いいえ イメージの ID。複数のイメージ ID を指定し、これらの ID をコンマ (,) で区切ることができます。
StatusStringいいえイメージの状態。オプションの値:
  • Creating:イメージが作成されています。
  • Available:利用可能なイメージ。
  • Unavailable:利用不可イメージ。
  • CreateFailed:失敗したイメージ。
デフォルト値:Available は複数の値を持つことができます。これらの値は、コンマ(,)で区切られます.
SnapshotId String いいえ イメージの作成に使用されるスナップショットの ID
ImageName String いいえ イメージの名前
ImageOwnerAlias string いいえ イメージ所有者のエイリアス。オプションの値:
  • system: Alibaba Cloud によって提供されるパブリックイメージ。
  • self: カスタムイメージ。
  • others: 他の Alibaba Cloud ユーザーから共有されているイメージ。
Usage String いいえ 指定されたイメージが ECS インスタンス上で実行されているかどうかを照会します。オプションの値:
  • instance: イメージは ECS インスタンスで実行されています。
  • none: イメージは使用されていません。
Tag.n.Key String いいえ タグのキー。nの値の範囲は [1, 5] です。
タグに従ってイメージを照会すると、Tag.n.Keyの値は空文字にすることはできません。
Tag.n.Value String いいえ nの値の範囲は [1, 5] です。
タグに従ってイメージを照会すると、Tag.n.Valueの値は空文字列になります。
PageNumber Integer いいえ インスタンスステータスリストのページ番号。開始値は 1、デフォルト値は 1 です。
PageSize Integer いいえ クエリのページあたりの行数を設定します。最大値は 50、デフォルト値は 10 です。

レスポンスパラメータ

名前 説明
RegionId String イメージのリージョン ID
TotalCount Integer リストに含まれる項目の数
PageNumber Integer 現在のページ
PageSize Integer 現在のページに含まれる項目の数
Images ImageType イメージ情報 ImageType で構成される集合

リクエストの例

  1. https://ecs.aliyuncs.com/?Action=DescribeImages
  2. &RegionId=cn-hangzhou
  3. &<Common Request Parameters>

レスポンスの例

XML 形式

  1. <DescribeImagesResponse>
  2. <Images>
  3. <Image>
  4. <Architecture>i386</Architecture>
  5. <CreationTime>2014-07-22T09:53:44Z</CreationTime>
  6. <Description></Description>
  7. <DiskDeviceMappings>
  8. <DiskDeviceMapping>
  9. <Device>/dev/xvda</Device>
  10. <Size>20</Size>
  11. <SnapshotId></SnapshotId>
  12. </DiskDeviceMapping>
  13. </DiskDeviceMappings>
  14. <ImageId>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageId>
  15. <ImageName>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageName>
  16. <ImageOwnerAlias>system</ImageOwnerAlias>
  17. <ImageVersion>1.0</ImageVersion>
  18. <IsCopied>false</IsCopied>
  19. <IsSubscribed>false</IsSubscribed>
  20. <OSName>SUSE Linux Enterprise Server 11 SP3 64bit</OSName>
  21. <ProductCode></ProductCode>
  22. <OSType>linux</OSType>
  23. <Platform>SUSE</Platform>
  24. <Progress>100</Progress>
  25. <Size>20</Size>
  26. <Status>Available</Status>
  27. <Usage>instance</Usage>
  28. </Image>
  29. </Images>
  30. <PageNumber>1</PageNumber>
  31. <PageSize>2</PageSize>
  32. <RegionId>cn-hangzhou</RegionId>
  33. <TotalCount>24</TotalCount>
  34. <RequestId>7871BB26-3002-4950-B2E6-98D333077EA5</RequestId>
  35. </DescribeImagesResponse>

JSON 形式

  1. {
  2. "Images": {
  3. "Image": [
  4. {
  5. "Architecture": "x86_64",
  6. "CreationTime": "2015-05-06T09:01:32Z",
  7. "DiskDeviceMappings": {
  8. "DiskDeviceMapping": [
  9. {
  10. "Device": "/dev/xvda",
  11. "Size": "20"
  12. }
  13. ]
  14. },
  15. "ImageId": "suse11sp3_64_20G_aliaegis_20150428.vhd",
  16. "ImageName": "suse11sp3_64_20G_aliaegis_20150428.vhd",
  17. "ImageOwnerAlias": "system",
  18. "ImageVersion": "1",
  19. "IsCopied": false,
  20. "IsSubscribed": false,
  21. "OSName": "SUSE Linux Enterprise Server 11 SP3 64bit",
  22. "OSType": "linux",
  23. "Platform": "SUSE",
  24. "Progress": "100%",
  25. "Size": 20,
  26. "Status": "Available",
  27. "Usage": "instance"
  28. }
  29. ]
  30. }
  31. "PageNumber": 1,
  32. "PageSize": 1,
  33. "RegionId": "cn-hangzhou",
  34. "RequestId": "49CBCED4-C9B9-4851-BEB5-8FB5E5169E30",
  35. "TotalCount": 24
  36. }

エラーコード

このインタフェースに固有のエラーコードは次のとおりです。詳細については、API エラー・センターを参照してください。

エラーコード エラーメッセージ HTTPステータスコード 意味
Invalidimageowneralias. valuenotsupported The specified ImageOwnerAlias value is not supported. 400 無効な ImageOwnerAlias 値。
Invalidtag. Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 400 タグのキー(Tag.n.Key)と値(Tag.n.Value)のキーと値が一致する必要があります。
InvalidTagCount The specified tags are beyond the permitted range. 400 最大 5 つのタグを指定できます。
InvalidUsage The specifed Usage is not valid. 404 指定された Usage パラメータが無効です。