ImageId、イメージの使用シナリオ、フィルター条件などのパラメーターを指定して、利用可能なイメージリソースのリストを照会します。
操作説明
照会できるイメージリソースには、カスタムイメージ、Alibaba Cloud が提供するパブリックイメージ、Alibaba Cloud マーケットプレイスイメージ、および他の Alibaba Cloud ユーザーが共有した共有イメージが含まれます。
ページングがサポートされています。クエリ結果には、利用可能なイメージリソースの総数と現在のページのイメージリソースが含まれます。1 ページあたりのデフォルトのエントリ数は 10 です。
クラウドアシスタント CLI を使用して API オペレーションを呼び出す場合、異なるデータタイプのリクエストパラメーターは形式要件に準拠する必要があります。詳細については、「CLI パラメーター形式」を参照してください。
Alibaba Cloud が提供するイメージまたは共有イメージ (ImageOwnerAlias が system または others にセットされている場合) を照会する場合、リクエストは RAM 認証ルールをバイパスできます。詳細については、「認証ルール」を参照してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeImages |
get |
Image。
Image。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
イメージのリージョン ID。最新のリージョンリストを照会するには、 DescribeRegions を呼び出せます。 |
cn-hangzhou |
| Status |
string |
任意 |
イメージのステータス。有効な値:
デフォルト値: Available。Status は Usable が指定されている場合にのみ必須となり、その場合はデフォルト値がありません。 説明
このパラメーターは、カンマ (,) で区切られた複数の値をサポートします。値が ALL にセットされている場合、すべてのステータスのイメージが照会されます。ALL を他のステータス値と一緒に使用することはできません。 |
Available |
| ImageId |
string |
任意 |
イメージ ID。 |
m-bp1g7004ksh0oeuc**** |
| ShowExpired |
boolean |
任意 |
サブスクリプションイメージが使用期間を超えているかどうかを指定します。 |
false |
| SnapshotId |
string |
任意 |
カスタムイメージの作成に使用されたスナップショットの ID。 |
s-bp17ot2q7x72ggtw**** |
| ImageName |
string |
任意 |
イメージ名。あいまい検索がサポートされています。 |
testImageName |
| ImageFamily |
string |
任意 |
イメージ ファミリーの名前。このパラメーターをセットして、指定されたイメージ ファミリーに属するイメージをフィルターできます。 デフォルト値: 空。 説明
Alibaba Cloud パブリックイメージに関連付けられたイメージ ファミリーの詳細については、「パブリックイメージの概要」を参照してください。 |
hangzhou-daily-update |
| ImageOwnerAlias |
string |
任意 |
イメージのソース。有効な値:
デフォルト値: 空。 説明
空の値を指定すると、system、self、および others の値を持つ結果が返されます。 |
self |
| InstanceType |
string |
任意 |
利用可能なイメージを照会する対象のインスタンスタイプ。 |
ecs.g5.large |
| Usable |
boolean |
任意 |
イメージが利用可能かどうかを指定します。 説明
利用可能なイメージとは、インスタンスの作成にすぐに使用できるイメージを示します。その他のシナリオについては、「即時イメージ可用性」を参照してください。 |
true |
| IsSupportIoOptimized |
boolean |
任意 |
イメージが I/O 最適化インスタンスで実行可能かどうかを指定します。 |
true |
| IsSupportCloudinit |
boolean |
任意 |
イメージが cloud-init をサポートしているかどうかを指定します。 |
true |
| OSType |
string |
任意 |
イメージのオペレーティングシステムタイプ。有効な値:
|
linux |
| Architecture |
string |
任意 |
イメージのアーキテクチャ。有効な値:
|
i386 |
| PageNumber |
integer |
任意 |
リソースリストのページ番号。 最小値: 1。 デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリの 1 ページあたりのエントリ数。このパラメーターを設定すると、各ページで返されるエントリ数が指定されます。 最大値: 100。 デフォルト値: 10。 |
10 |
| Usage |
string |
任意 |
イメージが ECS インスタンスで実行中かどうかを指定します。有効な値:
|
instance |
| DryRun |
boolean |
任意 |
実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。
デフォルト値: false。 |
false |
| ActionType |
string |
任意 |
イメージが使用されるシナリオ。有効な値:
|
CreateEcs |
| ResourceGroupId |
string |
任意 |
カスタムイメージが属するエンタープライズリソースグループの ID。このパラメーターを使用してリソースをフィルターする場合、リソース数は 1000 を超えることはできません。 説明
デフォルトリソースグループによるフィルタリングはサポートされていません。 |
rg-bp67acfmxazb4p**** |
| Tag |
array<object> |
任意 |
タグのリスト。 |
|
|
object |
任意 |
タグ情報。 |
||
| key |
string |
任意 |
イメージのタグキー。 説明
このパラメーターは非推奨になります。互換性を高めるために、Tag.N.Key を使用してください。 |
null |
| Key |
string |
任意 |
イメージのタグキー。N の有効な値: 1〜20。 単一のタグを使用してリソースをフィルターする場合、このタグを持つリソース数は 1000 を超えることはできません。複数のタグを使用してリソースをフィルターする場合、指定されたすべてのタグが付加されたリソース数は 1000 を超えることはできません。リソース数が 1000 を超える場合は、 ListTagResources 操作を使用してリソースをクエリしてください。 |
TestKey |
| Value |
string |
任意 |
イメージのタグ値。N の有効な値: 1〜20。 |
TestValue |
| value |
string |
任意 |
イメージのタグ値。 説明
このパラメーターは非推奨になります。互換性を高めるために、Tag.N.Value を使用してください。 |
null |
| Filter |
array<object> |
任意 |
リソースをクエリするためのフィルター条件のリスト。 |
|
|
object |
任意 |
リソースをクエリするためのフィルター条件。 |
||
| Key |
string |
任意 |
リソースをクエリするためのフィルターキー。有効な値:
デフォルト値: null。 |
CreationStartTime |
| Value |
string |
任意 |
リソースをクエリするためのフィルター値。
デフォルト値: null。 |
2017-12-05T22:40Z |
| IsPublic |
boolean |
任意 |
公開済みのコミュニティイメージをクエリするかどうかを指定します。有効な値:
デフォルト値: false。 |
false |
| ImageOwnerId |
integer |
任意 |
イメージが属する Alibaba Cloud アカウントの ID。このパラメーターは、共有イメージまたはコミュニティイメージをクエリする場合にのみ効果が有効です。 |
20169351435666**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| PageSize |
integer |
ページサイズ。 |
1 |
| PageNumber |
integer |
ページ番号。 |
1 |
| RequestId |
string |
リクエスト ID |
66189103-EDB2-43E2-BB60-BFF2B62F4EB8 |
| TotalCount |
integer |
イメージの総数。 |
1 |
| RegionId |
string |
イメージのリージョン ID。 |
cn-hangzhou |
| Images |
object |
||
| Image |
array<object> |
イメージ情報のコレクション。 |
|
|
array<object> |
イメージ情報。 |
||
| CreationTime |
string |
イメージが作成された時間。 |
2019-11-15T06:07:05Z |
| Status |
string |
イメージのステータス。有効な値:
|
Available |
| ImageFamily |
string |
イメージ ファミリーの名前。 |
hangzhou-daily-update |
| Progress |
string |
イメージ作成の進捗状況 (パーセンテージ)。 |
100% |
| IsCopied |
boolean |
イメージが他のイメージのコピーであるかどうかを示します。 |
false |
| IsSupportIoOptimized |
boolean |
イメージを I/O 最適化インスタンスで使用できるかどうかを示します。 |
true |
| ImageOwnerAlias |
string |
イメージのソース。有効な値:
|
self |
| IsSupportCloudinit |
boolean |
イメージが Cloud Init をサポートしているかどうかを示します。 |
true |
| ImageVersion |
string |
イメージバージョン。 |
2 |
| Usage |
string |
イメージを参照するリソースのタイプ。有効な値:
|
none |
| IsSelfShared |
string |
カスタムイメージが他のユーザーと共有されているかどうかを示します。 |
true |
| Description |
string |
イメージの説明。 |
Archive log for Oracle |
| Size |
integer |
イメージのサイズ。単位: GiB。 重要
イメージにデータディスクが含まれている場合、このパラメーターはイメージに関連付けられたシステムディスクのスナップショットのサイズのみを示します。
|
60 |
| ResourceGroupId |
string |
イメージが属するリソースグループの ID。 |
rg-bp67acfmxazb4p**** |
| Platform |
string |
オペレーティングシステムのプラットフォーム。 |
Windows Server 2016 |
| OSNameEn |
string |
オペレーティングシステムの英語名。 |
Windows Server 2016 Data Center エディション 64ビット Chinese Edition |
| ImageName |
string |
イメージの名前。 |
testImageName |
| OSName |
string |
オペレーティングシステムの中国語名。 |
Windows Server 2016 Datacenter 64-bit |
| ImageId |
string |
イメージ ID |
m-bp1g7004ksh0oeuc**** |
| OSType |
string |
オペレーティングシステムのタイプ。有効な値:
|
windows |
| IsSubscribed |
boolean |
Alibaba Cloud マーケットプレイスイメージの利用規約に同意しているかどうかを示します。 |
false |
| ProductCode |
string |
Alibaba Cloud マーケットプレイスイメージのプロダクトコード。 |
test000**** |
| Architecture |
string |
イメージのシステムアーキテクチャータイプ。有効な値:
|
x86_64 |
| BootMode |
string |
イメージのブートモード。有効な値:
イメージのブートモードの詳細については、「イメージのブートモード」を参照してください。 |
BIOS |
| DiskDeviceMappings |
object |
||
| DiskDeviceMapping |
array<object> |
イメージ内のディスクとスナップショットのマッピング関係のコレクション。 |
|
|
object |
イメージ内のディスクとスナップショットのマッピング関係。 |
||
| Type |
string |
イメージのタイプ。 |
system |
| ImportOSSBucket |
string |
インポートされたイメージを含む OSS バケット。 |
testEcsImport |
| Progress |
string |
コピー中のイメージのイメージコピータスクの進捗状況。 |
32% |
| SnapshotId |
string |
スナップショットの ID。 |
s-bp17ot2q7x72ggtw**** |
| ImportOSSObject |
string |
インポートされたイメージを含む OSS オブジェクト。 |
イメージImport |
| Device |
string |
/dev/xvdb などのディスクのデバイス名。 |
/dev/xvda |
| Size |
string |
ディスクのサイズ。単位: GiB。 |
60 |
| RemainTime |
integer |
コピー中のイメージのイメージコピータスクの残り時間。単位: 秒。 |
233 |
| Format |
string |
イメージの初期化形式。 |
qcow2 |
| Encrypted |
boolean |
説明
このパラメーターは招待プレビュー中です。 |
true |
| Tags |
object |
||
| Tag |
array<object> |
イメージのタグキーと値のペアのリスト。 |
|
|
object |
イメージのタグキーと値のペア。 |
||
| TagValue |
string |
イメージのタグ値。 |
Oracle |
| TagKey |
string |
イメージのタグキー。 |
DTS |
| IsPublic |
boolean |
イメージがパブリックであるかどうかを示します。パブリックイメージには、Alibaba Cloud が提供するパブリックイメージと、コミュニティイメージとして公開したカスタムイメージが含まれます。有効な値:
|
false |
| ImageOwnerId |
integer |
イメージが属する Alibaba Cloud アカウントの ID。このパラメーターは、共有イメージまたはコミュニティイメージをクエリする場合にのみ効果が適用されます。 |
1234567890 |
| LoginAsNonRootSupported |
boolean |
イメージがルート以外のユーザーでのログインをサポートしているかどうかを示します。有効な値:
|
false |
| SupplierName |
string |
コミュニティイメージプロバイダーの認証済み企業名。 |
TestName |
| DetectionOptions |
object |
イメージ検出結果。 |
|
| Status |
string |
イメージ検出タスクのステータス。有効な値:
|
Processing |
| Items |
object |
||
| Item |
array<object> |
イメージ検出項目のリスト。 |
|
|
object |
イメージ検出項目。 |
||
| Name |
string |
イメージ検出項目の名前。 |
Nvme |
| Value |
string |
イメージ検出項目の結果。 |
Supported |
| RiskLevel |
string |
インポートされたカスタムイメージ検出項目のリスクレベル。このフィールドは、リスクが存在する場合にのみ返されます。 有効な値:
|
High |
| RiskCode |
string |
検出項目の潜在的な欠陥。 |
NVMe.NotInstalled |
| Features |
object |
イメージの特徴関連属性。 |
|
| NvmeSupport |
string |
イメージが NVMe をサポートしているかどうかを示します。有効な値:
|
supported |
| ImdsSupport |
string |
イメージのメタデータアクセスモード。有効な値:
|
v2 |
| CpuOnlineUpgrade |
string |
CPU のホットアップグレードがサポートされているかどうかを示します。有効な値:
|
supported |
| CpuOnlineDowngrade |
string |
CPU のホットスペックダウンがサポートされているかどうかを示します。有効な値:
|
supported |
| MemoryOnlineUpgrade |
string |
メモリのホットアップグレードがサポートされているかどうかを示します。有効な値:
|
unsupported |
| MemoryOnlineDowngrade |
string |
メモリのホットスペックダウンがサポートされているかどうかを示します。有効な値:
|
unsupported |
| LicenseType |
string |
ライセンスタイプ。このプロパティは、このイメージから作成された ECS インスタンスの課金方法とアクティベーションロジックを決定します。このパラメーターは Windows サーバーイメージに対してのみ意味を持ちます。有効な値:
|
BYOL |
| Usable |
boolean |
イメージが使用可能かどうかを示します。有効な値:
|
true |
| SecureBootOptions |
object |
Secure Boot 関連のパラメーター。 |
|
| SecureBootSupport |
string |
イメージが Secure Boot をサポートしているかどうかを示します。有効な値:
|
supported |
例
成功レスポンス
JSONJSON
{
"PageSize": 1,
"PageNumber": 1,
"RequestId": "66189103-EDB2-43E2-BB60-BFF2B62F4EB8",
"TotalCount": 1,
"RegionId": "cn-hangzhou",
"Images": {
"Image": [
{
"CreationTime": "2019-11-15T06:07:05Z",
"Status": "Available",
"ImageFamily": "hangzhou-daily-update",
"Progress": "100%",
"IsCopied": false,
"IsSupportIoOptimized": true,
"ImageOwnerAlias": "self",
"IsSupportCloudinit": true,
"ImageVersion": "2",
"Usage": "none",
"IsSelfShared": "true",
"Description": "Archive log for Oracle",
"Size": 60,
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"Platform": "Windows Server 2016",
"OSNameEn": "Windows Server 2016 Data Center エディション 64ビット Chinese Edition",
"ImageName": "testImageName",
"OSName": "Windows Server 2016 Datacenter 64ビット Chinese エディション",
"ImageId": "m-bp1g7004ksh0oeuc****",
"OSType": "windows",
"IsSubscribed": false,
"ProductCode": "test000****",
"Architecture": "x86_64",
"BootMode": "BIOS",
"DiskDeviceMappings": {
"DiskDeviceMapping": [
{
"Type": "system",
"ImportOSSBucket": "testEcsImport",
"Progress": "32%",
"SnapshotId": "s-bp17ot2q7x72ggtw****",
"ImportOSSObject": "イメージImport",
"Device": "/dev/xvda",
"Size": "60",
"RemainTime": 233,
"Format": "qcow2",
"Encrypted": true
}
]
},
"Tags": {
"Tag": [
{
"TagValue": "Oracle",
"TagKey": "DTS"
}
]
},
"IsPublic": false,
"ImageOwnerId": 1234567890,
"LoginAsNonRootSupported": false,
"SupplierName": "TestName",
"DetectionOptions": {
"Status": "Processing",
"Items": {
"Item": [
{
"Name": "Nvme",
"Value": "Supported",
"RiskLevel": "High",
"RiskCode": "NVMe.NotInstalled"
}
]
}
},
"Features": {
"NvmeSupport": "supported",
"ImdsSupport": "v2",
"CpuOnlineUpgrade": "supported",
"CpuOnlineDowngrade": "supported",
"MemoryOnlineUpgrade": "unsupported",
"MemoryOnlineDowngrade": "unsupported"
},
"LicenseType": "BYOL",
"Usable": true,
"SecureBootOptions": {
"SecureBootSupport": "supported"
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidImageOwnerAlias.ValueNotSupported | The specified ImageOwnerAlias value is not supported. | 指定されたイメージオーナーエイリアスが無効です。パラメーターが正しいかどうかを確認してください。 |
| 400 | InvalidParamter | Invalid Parameter. | リクエストに無効なパラメーターが含まれています。 |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 指定された Tag.N.Key と Tag.N.Value が一致しません。 |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | 指定されたタグが有効値の範囲外です。 |
| 400 | InvalidInstanceType.ValueNotSupported | The specified instance type %s does not exist. You can use the DescribeInstanceTypes API to query the available instance types. | 指定されたインスタンスタイプは利用可能な範囲外のため無効です。 |
| 400 | InvalidFilterValue.NetworkType | The specified networkType value in the Filter is invalid. | フィルターで指定されたネットワークタイプの値が無効です。 |
| 400 | InvalidOperation.ImageOwnerIdUnsupported | The parameter "ImageOwnerId" is not supported in this context, it is only valid when querying shared images or community images. | ここでは ImageOwnerId パラメーターはサポートされていません。このパラメーターは、共有イメージまたはコミュニティイメージをクエリする場合にのみ有効です。 |
| 400 | InvalidImageOwnerAlias.PublicImageUnsupported | When querying images, the parameter ImageOwnerAlias should be others while specified parameter IsPublic is true. | イメージクエリで IsPublic パラメーターが true に設定されている場合、ImageOwnerAlias パラメーターは others に設定する必要があります。 |
| 400 | MissingParameter.Status | The specified parameter Status is not supplied. | Status パラメーターを空にすることはできません。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | CurrentAccount.NotSupportPublicImage | Public image is not supported for current account. | 現在のユーザーはパブリックイメージを使用できません。 |
| 404 | InvalidFilterKey.NotFound | The specified Filter Key is not found. | 指定された開始時刻または有効期限パラメーターが無効です。 |
| 404 | InvalidFilterValue | The specified Filter Value is not valid. | 入力された時刻の形式が無効です。 |
| 404 | InvalidUsage | The specified Usage is not valid. | 参照関係を持つ指定されたリソースタイプ (image、disk、image_disk、none) が無効です。 |
| 404 | InvalidOSType | The specified OSType is not valid. | 指定されたオペレーティングシステムはサポートされていません。 |
| 404 | InvalidArchitecture | The specified Architecture is not valid. | 指定されたアーキテクチャが存在しません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。