Mengkueri daftar resource image yang tersedia berdasarkan parameter tertentu seperti ImageId, skenario penggunaan image, dan kondisi Filter.
Deskripsi operasi
Resource image yang dapat Anda kueri meliputi gambar kustom Anda, gambar publik yang disediakan oleh Alibaba Cloud, gambar Alibaba Cloud Marketplace, dan gambar bersama yang dibagikan oleh pengguna Alibaba Cloud lain kepada Anda.
Mendukung paging. Hasil kueri mencakup jumlah total resource image yang tersedia dan resource image pada halaman saat ini. Jumlah entri default per halaman adalah 10.
Saat memanggil operasi API menggunakan CLI Asisten Cloud, tentukan parameter permintaan dengan tipe data berbeda dalam format yang diperlukan. Untuk informasi lebih lanjut, lihat Ikhtisar format parameter.
Saat mengkueri gambar yang disediakan oleh Alibaba Cloud atau gambar bersama (ImageOwnerAlias diatur ke system atau others), aturan otentikasi RAM dapat dilewati untuk permintaan ini. Untuk informasi lebih lanjut, lihat Aturan otentikasi.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeImages |
get |
Image
Image
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah image. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru. |
cn-hangzhou |
| Status |
string |
No |
Status image. Nilai valid:
Nilai default: Available. Jika Usable ditentukan, Status wajib diisi dan tidak memiliki nilai default. Catatan
Parameter ini mendukung beberapa nilai yang dipisahkan oleh koma (,). Jika nilai diatur ke ALL, image dengan semua status akan dikueri. ALL tidak dapat digunakan bersama dengan nilai status lainnya. |
Available |
| ImageId |
string |
No |
ID image. |
m-bp1g7004ksh0oeuc**** |
| ShowExpired |
boolean |
No |
Apakah image langganan telah kedaluwarsa. |
false |
| SnapshotId |
string |
No |
ID snapshot yang digunakan untuk membuat gambar kustom. |
s-bp17ot2q7x72ggtw**** |
| ImageName |
string |
No |
Nama image. Mendukung pencarian fuzzy. |
testImageName |
| ImageFamily |
string |
No |
Nama keluarga gambar. Anda dapat mengatur parameter ini untuk memfilter gambar yang termasuk dalam keluarga gambar tertentu. Nilai default: kosong. Catatan
Untuk informasi tentang keluarga gambar yang terkait dengan gambar publik Alibaba Cloud, lihat Ikhtisar gambar publik. |
hangzhou-daily-update |
| ImageOwnerAlias |
string |
No |
Sumber image. Nilai valid:
Nilai default: kosong. Catatan
Nilai kosong mengembalikan hasil dengan nilai system, self, dan others. |
self |
| InstanceType |
string |
No |
Tipe instans untuk image yang tersedia dikueri. |
ecs.g5.large |
| Usable |
boolean |
No |
Apakah image dapat digunakan. Catatan
Image yang dapat digunakan dapat segera digunakan untuk membuat instans. Untuk skenario kegunaan lainnya, lihat Akses instan snapshot. |
true |
| IsSupportIoOptimized |
boolean |
No |
Apakah image dapat berjalan pada instans yang dioptimalkan I/O. |
true |
| IsSupportCloudinit |
boolean |
No |
Apakah image mendukung cloud-init. |
true |
| OSType |
string |
No |
Tipe sistem operasi image. Nilai valid:
|
linux |
| Architecture |
string |
No |
Arsitektur image. Nilai valid:
|
i386 |
| PageNumber |
integer |
No |
Nomor halaman resource image. Nilai awal: 1. Nilai default: 1. |
1 |
| PageSize |
integer |
No |
Jumlah entri per halaman dalam kueri paging. Atur jumlah entri yang dikembalikan pada setiap halaman. Nilai maksimum: 100. Nilai default: 10. |
10 |
| Usage |
string |
No |
Apakah image sedang berjalan pada Instans ECS. Nilai valid:
|
instance |
| DryRun |
boolean |
No |
Apakah akan melakukan dry run saja, tanpa melakukan permintaan aktual.
Nilai default: false. |
false |
| ActionType |
string |
No |
Skenario penggunaan image. Nilai valid:
|
CreateEcs |
| ResourceGroupId |
string |
No |
ID kelompok sumber daya tempat gambar kustom berada. Saat menggunakan parameter ini untuk memfilter resource, jumlah resource tidak boleh melebihi 1000. Catatan
Memfilter berdasarkan kelompok sumber daya default tidak didukung. |
rg-bp67acfmxazb4p**** |
| Tag |
array<object> |
No |
Daftar tag. |
|
|
object |
No |
Informasi tag. |
||
| key |
string |
No |
Kunci tag image. Catatan
Parameter ini akan didepresiasi. Untuk meningkatkan kompatibilitas, gunakan |
null |
| Key |
string |
No |
Kunci tag image. Nilai valid N: 1 hingga 20. Saat menggunakan satu tag untuk memfilter resource, jumlah resource dengan tag ini tidak boleh melebihi 1000. Saat menggunakan beberapa tag untuk memfilter resource, jumlah resource yang memiliki semua tag tertentu terpasang tidak boleh melebihi 1000. Jika jumlah resource melebihi 1000, panggil operasi ListTagResources. |
TestKey |
| Value |
string |
No |
Nilai tag image. Nilai valid N: 1 hingga 20. |
TestValue |
| value |
string |
No |
Nilai tag image. Catatan
Parameter ini akan didepresiasi. Untuk meningkatkan kompatibilitas, gunakan |
null |
| Filter |
array<object> |
No |
Daftar kondisi filter untuk mengkueri resource. |
|
|
object |
No |
Kondisi filter untuk mengkueri resource. |
||
| Key |
string |
No |
Kunci filter untuk mengkueri resource. Nilai valid:
Nilai default: null. |
CreationStartTime |
| Value |
string |
No |
Nilai filter untuk mengkueri resource.
Nilai default: null. |
2017-12-05T22:40Z |
| IsPublic |
boolean |
No |
Apakah akan mengkueri gambar komunitas yang diterbitkan. Nilai valid:
Nilai default: false. |
false |
| ImageOwnerId |
integer |
No |
ID akun Alibaba Cloud pemilik image. Parameter ini hanya berlaku saat Anda mengkueri gambar bersama atau gambar komunitas. |
20169351435666**** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| PageSize |
integer |
Jumlah entri pada halaman saat ini. |
1 |
| PageNumber |
integer |
Nomor halaman saat ini. |
1 |
| RequestId |
string |
ID permintaan. |
66189103-EDB2-43E2-BB60-BFF2B62F4EB8 |
| TotalCount |
integer |
Jumlah total image. |
1 |
| RegionId |
string |
ID wilayah image. |
cn-hangzhou |
| Images |
object |
||
| Image |
array<object> |
Koleksi informasi image. |
|
|
array<object> |
Informasi image. |
||
| CreationTime |
string |
Waktu image dibuat. |
2019-11-15T06:07:05Z |
| Status |
string |
Status image. Nilai valid:
|
Available |
| ImageFamily |
string |
Nama keluarga gambar. |
hangzhou-daily-update |
| Progress |
string |
Progres pembuatan image, dalam persentase. |
100% |
| IsCopied |
boolean |
Apakah image merupakan image yang disalin. |
false |
| IsSupportIoOptimized |
boolean |
Apakah image dapat berjalan pada instans yang dioptimalkan I/O. |
true |
| ImageOwnerAlias |
string |
Sumber image. Nilai valid:
|
self |
| IsSupportCloudinit |
boolean |
Apakah image mendukung cloud-init. |
true |
| ImageVersion |
string |
Versi gambar. |
2 |
| Usage |
string |
Tipe resource yang mereferensikan image. Nilai valid:
|
none |
| IsSelfShared |
string |
Apakah gambar kustom telah dibagikan kepada pengguna lain. |
true |
| Description |
string |
Deskripsi image. |
Archive log for Oracle |
| Size |
integer |
Ukuran image, dalam GiB. Penting
Jika image berisi disk data, parameter ini hanya mewakili ukuran snapshot disk sistem yang terkait dengan image.
|
60 |
| ResourceGroupId |
string |
ID kelompok sumber daya tempat image berada. |
rg-bp67acfmxazb4p**** |
| Platform |
string |
Platform sistem operasi. |
Windows Server 2016 |
| OSNameEn |
string |
Nama tampilan bahasa Inggris sistem operasi. |
Windows Server 2016 Data Center Edition 64bit Chinese Edition |
| ImageName |
string |
Nama image. |
testImageName |
| OSName |
string |
Nama tampilan bahasa Mandarin sistem operasi. |
Windows Server 2016 数据中心版 64位中文版 |
| ImageId |
string |
ID image. |
m-bp1g7004ksh0oeuc**** |
| OSType |
string |
Tipe sistem operasi. Nilai valid:
|
windows |
| IsSubscribed |
boolean |
Apakah Anda telah berlangganan ketentuan layanan untuk produk image yang sesuai dengan kode produk. |
false |
| ProductCode |
string |
Kode produk gambar Alibaba Cloud Marketplace. |
test000**** |
| Architecture |
string |
Tipe arsitektur sistem image. Nilai valid:
|
x86_64 |
| BootMode |
string |
Mode boot image. Nilai valid:
Untuk informasi lebih lanjut tentang mode boot image, lihat Mode boot image. |
BIOS |
| DiskDeviceMappings |
object |
||
| DiskDeviceMapping |
array<object> |
Koleksi hubungan pemetaan disk-ke-snapshot dalam image. |
|
|
object |
Hubungan pemetaan disk-ke-snapshot dalam image. |
||
| Type |
string |
Tipe image. |
system |
| ImportOSSBucket |
string |
Bucket OSS tempat image impor berada. |
testEcsImport |
| Progress |
string |
Progres tugas penyalinan image untuk image yang sedang disalin. |
32% |
| SnapshotId |
string |
ID snapshot. |
s-bp17ot2q7x72ggtw**** |
| ImportOSSObject |
string |
Objek OSS tempat image impor berada. |
imageImport |
| Device |
string |
Informasi perangkat disk, seperti /dev/xvdb. |
/dev/xvda |
| Size |
string |
Ukuran disk. Unit: GiB. |
60 |
| RemainTime |
integer |
Sisa waktu tugas penyalinan image untuk image yang sedang disalin. Unit: detik. |
233 |
| Format |
string |
Format image. |
qcow2 |
| Encrypted |
boolean |
Catatan
Parameter ini berada dalam pratinjau undangan. |
true |
| Tags |
object |
||
| Tag |
array<object> |
Daftar pasangan kunci-nilai tag image. |
|
|
object |
Informasi pasangan kunci-nilai tag image. |
||
| TagValue |
string |
Nilai tag image. |
Oracle |
| TagKey |
string |
Kunci tag image. |
DTS |
| IsPublic |
boolean |
Apakah image merupakan gambar publik. Gambar publik mencakup gambar publik yang disediakan oleh Alibaba Cloud dan gambar kustom yang Anda terbitkan sebagai gambar komunitas. Nilai valid:
|
false |
| ImageOwnerId |
integer |
ID akun Alibaba Cloud pemilik image. Parameter ini hanya berlaku saat Anda mengkueri gambar bersama atau gambar komunitas. |
1234567890 |
| LoginAsNonRootSupported |
boolean |
Apakah image mendukung login sebagai pengguna non-root. Nilai valid:
|
false |
| SupplierName |
string |
Nama perusahaan terverifikasi dari penyedia gambar komunitas. |
TestName |
| DetectionOptions |
object |
Hasil deteksi image. |
|
| Status |
string |
Status tugas deteksi image. Nilai valid:
|
Processing |
| Items |
object |
||
| Item |
array<object> |
Daftar item deteksi image. |
|
|
object |
Item deteksi image. |
||
| Name |
string |
Nama item deteksi image. |
Nvme |
| Value |
string |
Hasil item deteksi image. |
Supported |
| RiskLevel |
string |
Tingkat risiko item deteksi gambar kustom impor. Bidang ini hanya dikembalikan jika ada risiko. Nilai valid:
|
High |
| RiskCode |
string |
Cacat potensial dari item deteksi. |
NVMe.NotInstalled |
| Features |
object |
Atribut terkait fitur image. |
|
| NvmeSupport |
string |
Apakah image mendukung NVMe. Nilai valid:
|
supported |
| ImdsSupport |
string |
Mode akses metadata image. Nilai valid:
|
v2 |
| CpuOnlineUpgrade |
string |
Apakah Peningkatan CPU online didukung. Nilai valid:
|
supported |
| CpuOnlineDowngrade |
string |
Apakah menurunkan spesifikasi CPU online didukung. Nilai valid:
|
supported |
| MemoryOnlineUpgrade |
string |
Apakah Peningkatan memori online didukung. Nilai valid:
|
unsupported |
| MemoryOnlineDowngrade |
string |
Apakah menurunkan spesifikasi memori online didukung. Nilai valid:
|
unsupported |
| LicenseType |
string |
Tipe lisensi. Properti ini menentukan metode penagihan dan logika aktivasi untuk Instance ECS yang dibuat dari image ini. Hanya relevan untuk image Windows Server. Nilai valid:
|
BYOL |
| Usable |
boolean |
Apakah image dapat digunakan. |
true |
Contoh
Respons sukses
JSONformat
{
"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 Edition 64bit Chinese Edition",
"ImageName": "testImageName",
"OSName": "Windows Server 2016 数据中心版 64位中文版",
"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": "imageImport",
"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
}
]
}
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidImageOwnerAlias.ValueNotSupported | The specified ImageOwnerAlias value is not supported. | Alias pemilik image tidak valid. Periksa apakah parameter ini benar. |
| 400 | InvalidParamter | Invalid Parameter. | Parameter input tidak valid. |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | Tag.N.Key dan Tag.N.Value yang ditentukan tidak cocok. |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | Tag yang ditentukan berada di luar rentang valid. |
| 400 | InvalidInstanceType.ValueNotSupported | The specified instance type %s does not exist. You can use the DescribeInstanceTypes API to query the available instance types. | Tipe instans yang ditentukan tidak mendukung tipe disk data yang disambungkan ke instans saat ini. |
| 400 | InvalidFilterValue.NetworkType | The specified networkType value in the Filter is invalid. | Nilai jenis jaringan yang ditentukan dalam filter tidak valid. |
| 400 | InvalidOperation.ImageOwnerIdUnsupported | The parameter "ImageOwnerId" is not supported in this context, it is only valid when querying shared images or community images. | Parameter ImageOwnerId tidak didukung di sini. Parameter ini hanya valid saat Anda mengkueri gambar bersama atau gambar komunitas. |
| 400 | InvalidImageOwnerAlias.PublicImageUnsupported | When querying images, the parameter ImageOwnerAlias should be others while specified parameter IsPublic is true. | Saat mengkueri image, jika parameter IsPublic diatur ke true, parameter ImageOwnerAlias harus diatur ke others. |
| 400 | MissingParameter.Status | The specified parameter Status is not supplied. | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | CurrentAccount.NotSupportPublicImage | Public image is not supported for current account. | Pengguna saat ini tidak diizinkan menggunakan gambar publik. |
| 404 | InvalidFilterKey.NotFound | The specified Filter Key is not found. | Filter.N.Key yang ditentukan tidak valid. |
| 404 | InvalidFilterValue | The specified Filter Value is not valid. | Value dalam Filter tidak valid. |
| 404 | InvalidUsage | The specified Usage is not valid. | Parameter Usage tidak valid. |
| 404 | InvalidOSType | The specified OSType is not valid. | Parameter OSType tidak valid. |
| 404 | InvalidArchitecture | The specified Architecture is not valid. | Parameter arsitektur yang ditentukan tidak valid. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.