イメージ情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
appstreaming:ListImage |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ImageId |
string |
任意 |
イメージの ID。 |
img-bp13mu**** |
| ImageName |
string |
任意 |
イメージ名。あいまい一致がサポートされています。 |
DemoImage。 |
| Status |
string |
任意 |
イメージのステータス。クエリするイメージのステータスを指定します。デフォルトでは、削除されていないすべてのイメージがクエリされます。 列挙値:
|
INIT。 |
| ImageType |
string |
任意 |
イメージのタイプ。 列挙値:
|
User。 |
| PackageType |
string |
任意 |
イメージのパッケージタイプ。 列挙値:
|
Ecs。 |
| OsType |
string |
任意 |
イメージのオペレーティングシステムタイプ。 列挙値:
|
Windows。 |
| BizType |
integer |
任意 |
ビジネスタイプ。このパラメーターは一般公開されていません。 列挙値:
|
1 |
| ProductType |
string |
任意 |
プロダクトタイプ。 列挙値:
|
CloudApp。 |
| ProtocolType |
string |
任意 |
イメージのプロトコルタイプ。 列挙値:
|
ASP。 |
| PageSize |
integer |
任意 |
ページングクエリの 1 ページあたりのエントリ数。最大値: 100。デフォルト値: 10。 |
10 |
| PageNumber |
integer |
任意 |
現在のページ番号。 |
1 |
| ProductTypeList |
array |
任意 |
イメージが複数のプロダクトをサポートしている場合にサポートされるプロダクトのリスト。 |
|
|
string |
任意 |
プロダクトタイプ。 列挙値:
|
CloudApp。 |
|
| BizTypeList |
array |
任意 |
すべてのビジネスタイプのリスト。このパラメーターは一般公開されていません。 |
|
|
integer |
任意 |
ビジネスタイプ。ビジネス要件に基づいてこのパラメーターを設定します。 列挙値:
|
1 |
|
| FeatureList |
array |
任意 |
イメージがサポートする特徴のリスト。 |
|
|
string |
任意 |
イメージがサポートする特徴。 列挙値:
|
GPU。 |
|
| LanguageType |
string |
任意 |
言語。 列挙値:
|
zh-CN |
| ResourceInstanceType |
string |
任意 |
特定の固定仕様のイメージを照会します。 |
eds.enterprise_office.2c4g。 |
| FotaVersion |
string |
任意 |
イメージバージョン情報。 |
2.0.3-xxxx。 |
| PlatformName |
string |
任意 |
オペレーティングシステムのプラットフォーム名。 列挙値:
|
Windows Server 2019 |
| BizRegionIdList |
array |
任意 |
サポートされているリージョンのリスト。WUYING イメージは一元管理されています。このパラメーターを使用して、イメージがデプロイされているリージョンをクエリします。 |
|
|
string |
任意 |
リージョン ID。 |
cn-shanghai。 |
|
| TagList |
array<object> |
任意 |
クエリ用のタグ。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
ユーザー定義のタグキー。 |
env。 |
| Value |
string |
任意 |
ユーザー定義のタグ値。 |
test。 |
| PlatformNameList |
array |
任意 |
サポートされているプラットフォームタイプのリスト。有効な値については、上記の PlatformName を参照してください。 |
|
|
string |
任意 |
イメージのプラットフォーム名。 |
Windows 11 |
|
| Distro |
string |
任意 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
イメージ情報の構造体。 |
||
| PageSize |
integer |
1 ページあたりのエントリ数。 |
10 |
| PageNumber |
integer |
返されたデータのページ番号。 |
1 |
| Data |
array<object> |
返されたデータオブジェクト。 |
|
|
array<object> |
返されたオブジェクト。 |
||
| GmtCreate |
string |
作成時間。 |
2025-04-25 15:13:57 |
| GmtModified |
string |
更新時間。 |
2025-04-25 15:13:57 |
| AliUid |
integer |
テナント ID。 |
123456789 |
| ImageId |
string |
イメージの ID。システムイメージ ID は意味を持ちますが、カスタムイメージ ID は自動生成されます。 |
imgc-xxxx。 |
| ImageName |
string |
イメージ名。 |
DemoImage。 |
| ImageType |
string |
イメージのタイプ。 |
User。 |
| PackageType |
string |
イメージのパッケージタイプ。 |
ECS。 |
| Description |
string |
イメージの説明。 |
Description. |
| OsType |
string |
イメージのタイプ。 |
Windows。 |
| ProtocolType |
string |
プロトコルタイプ。 |
ASP。 |
| BizType |
integer |
ビジネスタイプ。 |
1 |
| ProductType |
string |
プロダクトタイプ。 |
CloudApp。 |
| VersionId |
string |
イメージバージョン。 |
iv-xxx。 |
| OnlineVersionId |
string |
現在のイメージがメインイメージ情報を読み取るサブバージョン。イメージは複数のサブバージョンで構成されています。 |
iv-xxxx。 |
| LatestVersionId |
string |
イメージの最新のサブバージョン。イメージは複数のサブバージョンで構成されています。 |
iv-xxx。 |
| Status |
string |
イメージのステータス。 |
INIT。 |
| ParentImageId |
string |
親イメージの ID。これは継承関係のみを示します。システムイメージには親イメージはありません。 |
imgc-xxx。 |
| ParentImageVersion |
string |
親イメージバージョン。 |
iv-xxx。 |
| BaseImageId |
string |
ベースイメージの ID。 |
imgc-xxx。 |
| BaseImageVersion |
string |
ベースイメージバージョン。 |
iv-xxx。 |
| FotaVersion |
string |
FOTA のバージョン。 |
2.3.0-xxx。 |
| Language |
string |
イメージの言語。パッケージタイプが VHD/Container の場合、このプロパティはイメージ組み合わせ内の ECS パッケージタイプライメージから継承されます。 |
zh-CN |
| Platform |
integer |
イメージのオペレーティングシステムプラットフォーム。 説明
パッケージタイプが VHD/Container の場合、このプロパティはイメージ組み合わせ内の ECS パッケージタイプライメージから継承されます。 |
Windows。 |
| OnlineVersion |
boolean |
現在のバージョンがアクティブなバージョンかどうかを示します。 |
true。 |
| SystemDiskSize |
integer |
システムクラウドディスクのサイズ。単位: GiB。 説明
システムクラウドディスクのサイズはイメージファイルより小さくすることはできません。 |
40 |
| DataDiskSize |
integer |
データクラウドディスクのサイズ。単位: GiB。 |
100 |
| AppList |
array<object> |
アプリケーションの設定。 |
|
|
object |
|||
| AppId |
string |
アプリケーション ID。 |
ca-xxx |
| AppName |
string |
アプリケーション名。 |
应用名称 |
| FeatureList |
array |
イメージの特徴タグのリスト。 |
|
|
string |
イメージの特徴タグ。 |
Builder。 |
|
| ImageCreateMode |
string |
イメージの作成タイプ。 列挙値:
|
BUILDER_MANUAL。 |
| ImageRegionList |
array |
リージョン。 |
|
|
string |
リージョンオブジェクト。 |
リージョンオブジェクト。 |
|
| Distro |
string |
ディストリビューション名。 |
Ubuntu 22.04 64-bit. |
| VersionName |
string |
バージョン名。 |
v0.1.0 |
| ResourceInstanceCategory |
string |
イメージがサポートするリソースタイプ。 |
["eds.cpu.category"] |
| PlatformName |
string |
システムプラットフォーム名。 |
Windows Server 2022 |
| SupportedLanguageList |
array |
サポートされている言語のリスト。 |
|
|
string |
サポートされている言語。 |
zh-CN |
|
| VolumeEncryptionEnabled |
boolean |
ディスク暗号化が有効かどうかを示します。 |
true。 |
| VolumeEncryptionKey |
string |
ディスク暗号化が有効な場合に使用される KMS キー ID。 |
a7b3c0c8-xxxx。 |
| SessionType |
string |
セッションタイプ。 列挙値:
|
SINGLE_SESSION。 |
| ImageRegionDistributeList |
array<object> |
オーバーレイ有効なリージョン情報。 |
|
|
object |
|||
| ImageId |
string |
イメージ ID。システムイメージの ID は意味のある値ですが、カスタムイメージの ID は自動的に生成されます。呼び出し時に返されます。 |
imgc-xxx |
| RegionId |
string |
サポートされるリージョン。 |
cn-shanghai |
| Status |
string |
ステータス。 |
INIT |
| VersionId |
string |
イメージバージョン。 |
iv-xxx |
| Progress |
string |
進捗率。 |
70% |
| FotaChannel |
string |
説明
このパラメーターは一般公開されていません。 |
イメージがサポートする FOTA チャネル。まだ有効化されていません。 |
| CompatibleMode |
boolean |
互換性モードが有効かどうかを示します。 |
true。 |
| DriverList |
array |
ドライバー情報のリスト。 |
|
|
string |
ドライバーリスト。 |
["00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] |
|
| Scene |
string |
AIGC。 |
|
| Rating |
integer |
95 |
|
| ImageIconUrl |
string |
||
| EnvironmentId |
string |
env-164c321f405ca84143e4b730dbe4 |
|
| TagList |
array<object> |
||
|
object |
|||
| Key |
string |
1630348213973321 |
|
| Value |
string |
inner |
|
| SnapshotList |
array<object> |
||
|
object |
|||
| SnapshotId |
string |
||
| VersionId |
string |
||
| DiskType |
string |
||
| DiskSubType |
string |
||
| BindType |
string |
||
| DiskCategory |
string |
||
| Size |
integer |
||
| Count |
integer |
エントリの総数。 |
22 |
| Success |
boolean |
呼び出しが成功したかどうかを示します。 列挙値:
|
true。 |
| Code |
string |
エラーコード。 |
200 |
| Message |
string |
API リクエストに対して返されたメッセージ。 |
success。 |
| RequestId |
string |
リクエスト ID。 |
8737D130-BFD0-5D51-96F6-C08EB1139A25 |
例
成功レスポンス
JSONJSON
{
"PageSize": 10,
"PageNumber": 1,
"Data": [
{
"GmtCreate": "2025-04-25 15:13:57",
"GmtModified": "2025-04-25 15:13:57",
"AliUid": 123456789,
"ImageId": "imgc-xxxx",
"ImageName": "DemoImage",
"ImageType": "User",
"PackageType": "ECS",
"Description": "描述",
"OsType": "Windows",
"ProtocolType": "ASP",
"BizType": 1,
"ProductType": "CloudApp",
"VersionId": "iv-xxx",
"OnlineVersionId": "iv-xxxx",
"LatestVersionId": "iv-xxx",
"Status": "INIT",
"ParentImageId": "imgc-xxx",
"ParentImageVersion": "iv-xxx",
"BaseImageId": "imgc-xxx",
"BaseImageVersion": "iv-xxx",
"FotaVersion": "2.3.0-xxx",
"Language": "zh-CN",
"Platform": 0,
"OnlineVersion": true,
"SystemDiskSize": 40,
"DataDiskSize": 100,
"AppList": [
{
"AppId": "ca-xxx",
"AppName": "应用名称"
}
],
"FeatureList": [
"Builder"
],
"ImageCreateMode": "BUILDER_MANUAL",
"ImageRegionList": [
"地域对象。"
],
"Distro": "Ubuntu 22.04 64位",
"VersionName": "v0.1.0",
"ResourceInstanceCategory": "[\"eds.cpu.category\"]",
"PlatformName": "Windows Server 2022",
"SupportedLanguageList": [
"zh-CN"
],
"VolumeEncryptionEnabled": true,
"VolumeEncryptionKey": "a7b3c0c8-xxxx",
"SessionType": "SINGLE_SESSION",
"ImageRegionDistributeList": [
{
"ImageId": "imgc-xxx",
"RegionId": "cn-shanghai",
"Status": "INIT",
"VersionId": "iv-xxx",
"Progress": "70%"
}
],
"FotaChannel": "镜像支持的fota渠道,暂未启用",
"CompatibleMode": true,
"DriverList": [
"[\"00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"]"
],
"Scene": "AIGC",
"Rating": 95,
"ImageIconUrl": "",
"EnvironmentId": "env-164c321f405ca84143e4b730dbe4",
"TagList": [
{
"Key": "1630348213973321",
"Value": "inner"
}
],
"SnapshotList": [
{
"SnapshotId": "",
"VersionId": "",
"DiskType": "",
"DiskSubType": "",
"BindType": "",
"DiskCategory": "",
"Size": 0
}
]
}
],
"Count": 22,
"Success": true,
"Code": "200",
"Message": "success",
"RequestId": "8737D130-BFD0-5D51-96F6-C08EB1139A25"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InternalError | Internal error. | |
| 400 | InvalidBizType | The bizType parameter is invalid. | |
| 403 | Forbidden.NoPermission | You are not authorized to access this page. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。