利用可能なイメージを照会します。このインターフェイスを呼び出すときは、次の点を考慮してください。
-
表示されたイメージリソースリストには、カスタムイメージ、Alibaba Cloud によって提供されるパブリックイメージ、および他の Alibaba Cloud ユーザーから共有されたイメージが含まれています。
-
ページごとの照会をサポートします。クエリの結果には、使用可能なイメージリソースの総数と、現在のページ上のイメージリソースが含まれます。デフォルトでは、1 ページに 10 個の結果が表示されます。
リクエストパラメーター
Action | String | はい | このインタフェースの名前。値: DescribeImages |
RegionId | String | はい | インスタンスが属するリージョンの ID。DescribeRegions を呼び出して最新のリージョンリストを取得してください。 |
ImageId | String | いいえ | イメージの ID。複数のイメージ ID を指定し、これらの ID をコンマ (, ) で区切ることができます。
|
Status | String | いいえ | イメージの状態。オプションの値:
, )で区切られます.
|
SnapshotId | String | いいえ | イメージの作成に使用されるスナップショットの ID |
ImageName | String | いいえ | イメージの名前 |
ImageOwnerAlias | string | いいえ | イメージ所有者のエイリアス。オプションの値:
|
Usage | String | いいえ | 指定されたイメージが ECS インスタンス上で実行されているかどうかを照会します。オプションの値:
|
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 で構成される集合 |
例
リクエストの例
https://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&<Common Request Parameters>
レスポンスの例
XML
形式
<DescribeImagesResponse>
<Images>
<Image>
<Architecture>i386</Architecture>
<CreationTime>2014-07-22T09:53:44Z</CreationTime>
<Description></Description>
<DiskDeviceMappings>
<DiskDeviceMapping>
<Device>/dev/xvda</Device>
<Size>20</Size>
<SnapshotId></SnapshotId>
</DiskDeviceMapping>
</DiskDeviceMappings>
<ImageId>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageId>
<ImageName>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageName>
<ImageOwnerAlias>system</ImageOwnerAlias>
<ImageVersion>1.0</ImageVersion>
<IsCopied>false</IsCopied>
<IsSubscribed>false</IsSubscribed>
<OSName>SUSE Linux Enterprise Server 11 SP3 64bit</OSName>
<ProductCode></ProductCode>
<OSType>linux</OSType>
<Platform>SUSE</Platform>
<Progress>100</Progress>
<Size>20</Size>
<Status>Available</Status>
<Usage>instance</Usage>
</Image>
</Images>
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<RegionId>cn-hangzhou</RegionId>
<TotalCount>24</TotalCount>
<RequestId>7871BB26-3002-4950-B2E6-98D333077EA5</RequestId>
</DescribeImagesResponse>
JSON
形式
{
"Images": {
"Image": [
{
"Architecture": "x86_64",
"CreationTime": "2015-05-06T09:01:32Z",
"DiskDeviceMappings": {
"DiskDeviceMapping": [
{
"Device": "/dev/xvda",
"Size": "20"
}
]
},
"ImageId": "suse11sp3_64_20G_aliaegis_20150428.vhd",
"ImageName": "suse11sp3_64_20G_aliaegis_20150428.vhd",
"ImageOwnerAlias": "system",
"ImageVersion": "1",
"IsCopied": false,
"IsSubscribed": false,
"OSName": "SUSE Linux Enterprise Server 11 SP3 64bit",
"OSType": "linux",
"Platform": "SUSE",
"Progress": "100%",
"Size": 20,
"Status": "Available",
"Usage": "instance"
}
]
}
"PageNumber": 1,
"PageSize": 1,
"RegionId": "cn-hangzhou",
"RequestId": "49CBCED4-C9B9-4851-BEB5-8FB5E5169E30",
"TotalCount": 24
}
エラーコード
このインタフェースに固有のエラーコードは次のとおりです。詳細については、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 パラメータが無効です。 |