All Products
Search
Document Center

:DescribeImages

Last Updated:May 22, 2026

Mengambil daftar gambar yang tersedia.

Catatan Penggunaan

  • Anda dapat mengambil custom image milik Anda, public image yang disediakan oleh Alibaba Cloud, Alibaba Cloud Marketplace image, serta shared image dari akun Alibaba Cloud lainnya.
  • Ini adalah kueri terpaginasi. Respons berisi jumlah total gambar yang tersedia dan daftar gambar pada halaman yang dikembalikan. Secara default, 10 entri ditampilkan per halaman.
  • Saat memanggil operasi API menggunakan Alibaba Cloud CLI, Anda harus menentukan nilai parameter permintaan dengan tipe berbeda dalam format yang diperlukan. Untuk informasi selengkapnya, lihat Parameter format overview.
  • Jika Anda mengatur ImageOwnerAlias ke system atau others saat memanggil operasi DescribeImages untuk mengambil gambar yang disediakan oleh Alibaba Cloud atau shared image, aturan autentikasi Resource Access Management (RAM) diabaikan dalam operasi tersebut. Untuk informasi selengkapnya, lihat Authentication rules.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kemudahan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter Permintaan

Parameter

Type

Required

Example

Description

Action String Yes DescribeImages

Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeImages.

RegionId String Yes cn-hangzhou

ID wilayah gambar. Anda dapat memanggil operasi DescribeRegions untuk menanyakan daftar wilayah terbaru.

Status String No Available

Status gambar. Secara default, jika Anda tidak menentukan parameter ini, hanya gambar dalam status Available yang dikembalikan. Nilai yang valid:

  • Creating: Gambar sedang dibuat.
  • Waiting: Gambar menunggu untuk diproses.
  • Available: Gambar tersedia.
  • UnAvailable: Gambar tidak tersedia.
  • CreateFailed: Pembuatan gambar gagal.
  • Deprecated: Gambar tidak lagi digunakan.

Nilai default: Available. Anda dapat menentukan beberapa nilai untuk parameter ini. Pisahkan nilai dengan koma (,).

ImageId String No m-bp1g7004ksh0oeuc****

ID gambar.

ShowExpired Boolean No false

Menentukan apakah gambar subscription telah kedaluwarsa.

Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan agar Anda menggunakan parameter lain untuk memastikan kompatibilitas di masa depan.
SnapshotId String No s-bp17ot2q7x72ggtw****

ID snapshot yang digunakan untuk membuat custom image.

ImageName String No testImageName

Nama gambar.

ImageFamily String No hangzhou-daily-update

Nama keluarga gambar. Anda dapat mengatur parameter ini untuk menanyakan gambar dari keluarga gambar tertentu.

Parameter ini kosong secara default.

Catatan Untuk informasi tentang keluarga gambar yang terkait dengan public image yang disediakan oleh Alibaba Cloud, lihat Overview.
ImageOwnerAlias String No self

Sumber gambar. Nilai yang valid:

  • system: public image yang disediakan oleh Alibaba Cloud tetapi tidak tersedia di Alibaba Cloud Marketplace.
  • self: custom image yang Anda buat.
  • others: shared image dari akun Alibaba Cloud lain atau community image yang dipublikasikan oleh pengguna Alibaba Cloud untuk digunakan oleh orang lain di komunitas Alibaba Cloud. Perhatikan hal-hal berikut:
    • Untuk menanyakan community image, Anda harus mengatur IsPublic ke true.
    • Untuk menanyakan shared image, Anda harus mengatur IsPublic ke false atau membiarkan parameter IsPublic kosong.
  • marketplace: gambar yang dirilis oleh Alibaba Cloud atau independent software vendor (ISV) di Alibaba Cloud Marketplace. Anda harus membeli gambar ini bersamaan dengan instance Elastic Compute Service (ECS). Perhatikan detail penagihan gambar tersebut.

Parameter ini kosong secara default.

Catatan Jika Anda membiarkan parameter ini kosong, custom image, gambar yang disediakan oleh Alibaba Cloud, shared image, dan community image akan ditanyakan.
InstanceType String No ecs.g5.large

Tipe instans tempat gambar dapat digunakan.

IsSupportIoOptimized Boolean No true

Menentukan apakah gambar dapat digunakan pada I/O optimized instances.

IsSupportCloudinit Boolean No true

Menentukan apakah gambar mendukung cloud-init.

OSType String No linux

Tipe sistem operasi gambar. Nilai yang valid:

  • windows
  • linux
Architecture String No i386

Arsitektur gambar. Nilai yang valid:

  • i386
  • x86_64
  • arm64
PageNumber Integer No 1

Nomor halaman.

Halaman dimulai dari halaman 1.

Nilai default: 1.

PageSize Integer No 1

Jumlah entri per halaman.

Nilai yang valid: 1 hingga 100.

Nilai default: 10.

Usage String No instance

Menentukan apakah gambar sedang berjalan pada instance ECS. Nilai yang valid:

  • instance: Gambar sudah digunakan dan sedang berjalan pada instance ECS.
  • none: Gambar tidak digunakan.
DryRun Boolean No false

Menentukan apakah hanya menjalankan dry run tanpa melakukan permintaan sebenarnya. Nilai yang valid:

  • true: hanya menjalankan dry run. Sistem memeriksa Pasangan Kunci Akses, izin Pengguna Resource Access Management (RAM), dan parameter yang diperlukan. Jika permintaan gagal dalam dry run, pesan kesalahan dikembalikan. Jika tidak, kode kesalahan DryRunOperation dikembalikan.
  • false: menjalankan dry run dan melakukan permintaan sebenarnya. Jika permintaan lolos dry run, kode status HTTP 2xx dikembalikan dan operasi dilakukan.

Nilai default: false.

ActionType String No CreateEcs

Skenario penggunaan gambar. Nilai yang valid:

  • CreateEcs (default): pembuatan instans.
  • ChangeOS: penggantian disk sistem atau sistem operasi.
ResourceGroupId String No rg-bp67acfmxazb4p****

ID kelompok sumber daya tempat custom image tersebut berada. Jika parameter ini ditentukan untuk menanyakan sumber daya, maksimal 1.000 sumber daya yang termasuk dalam kelompok sumber daya yang ditentukan akan dikembalikan.

Catatan Sumber daya dalam kelompok sumber daya default akan ditampilkan dalam respons terlepas dari pengaturan parameter ini.
Tag.N.key String No null

Kunci tag N gambar.

Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan agar Anda menggunakan Tag.N.Key untuk memastikan kompatibilitas di masa depan.
Tag.N.Key String No TestKey

Kunci tag N gambar. Nilai N yang valid: 1 hingga 20.

Jika satu tag ditentukan untuk menanyakan sumber daya, maksimal 1.000 sumber daya yang memiliki tag tersebut akan dikembalikan. Jika beberapa tag ditentukan untuk menanyakan sumber daya, maksimal 1.000 sumber daya yang memiliki semua tag tersebut akan dikembalikan. Untuk menanyakan lebih dari 1.000 sumber daya yang memiliki tag yang ditentukan, panggil operasi ListTagResources.

Tag.N.Value String No TestValue

Nilai tag N gambar. Nilai N yang valid: 1 hingga 20.

Tag.N.value String No null

Nilai tag N gambar.

Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan agar Anda menggunakan Tag.N.Value untuk memastikan kompatibilitas di masa depan.
Filter.N.Key String No CreationStartTime

Kunci filter N yang digunakan untuk menanyakan sumber daya. Nilai yang valid:

  • Jika Anda mengatur parameter ini ke CreationStartTime, Anda dapat menanyakan sumber daya yang dibuat setelah waktu yang ditentukan oleh parameter Filter.N.Value.
  • Jika Anda mengatur parameter ini ke CreationEndTime, Anda dapat menanyakan sumber daya yang dibuat sebelum waktu yang ditentukan oleh nilai Filter.N.Value.
Filter.N.Value String No 2017-12-05T22:40Z

Nilai filter N yang digunakan untuk menanyakan sumber daya. Tetapkan nilainya ke awal atau akhir rentang waktu yang ingin ditanyakan. Saat menentukan parameter ini, Anda juga harus menentukan Filter.N.Key. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC.

IsPublic Boolean No false

Menentukan apakah akan menanyakan community image yang dipublikasikan. Nilai yang valid:

  • true: menanyakan community image yang dipublikasikan. Jika Anda mengatur parameter ini ke true, Anda harus mengatur parameter ImageOwnerAlias ke others.
  • false: menanyakan tipe gambar selain community image. Tipe gambar spesifik yang ditanyakan ditentukan oleh nilai ImageOwnerAlias.

Nilai default: false.

ImageOwnerId Long No 1234567890

ID akun Alibaba Cloud pemilik gambar. Parameter ini hanya berlaku jika Anda menanyakan shared image atau community image.

Parameter Respons

Parameter

Type

Example

Description

PageSize Integer 1

Jumlah entri per halaman.

PageNumber Integer 1

Nomor halaman.

RequestId String 66189103-EDB2-43E2-BB60-BFF2B62F4EB8

ID permintaan.

TotalCount Integer 1

Jumlah total gambar.

RegionId String cn-hangzhou

ID wilayah gambar.

Images Array of Image

Informasi tentang gambar.

Image
CreationTime String 2019-11-15T06:07:05Z

Waktu pembuatan gambar.

Status String Available

Status gambar. Nilai yang valid:

  • UnAvailable
  • Available
  • Creating
  • CreateFailed
ImageFamily String hangzhou-daily-update

Nama keluarga gambar.

Progress String 100%

Progres pembuatan gambar. Satuan: persen (%).

IsCopied Boolean false

Menunjukkan apakah gambar merupakan salinan dari gambar lain.

IsSupportIoOptimized Boolean true

Menunjukkan apakah gambar dapat digunakan pada I/O optimized instances.

ImageOwnerAlias String self

Sumber gambar. Nilai yang valid:

  • system: public image yang disediakan oleh Alibaba Cloud.
  • self: custom image yang Anda buat.
  • others: shared image dari akun Alibaba Cloud lain atau community image yang dipublikasikan oleh akun Alibaba Cloud lain.
  • marketplace: Alibaba Cloud Marketplace image.
IsSupportCloudinit Boolean true

Menunjukkan apakah gambar mendukung cloud-init.

ImageVersion String 2

Versi gambar.

Usage String none

Menunjukkan apakah gambar digunakan untuk membuat instance ECS. Nilai yang valid:

  • instance: Gambar digunakan untuk membuat satu atau beberapa instance ECS.
  • none: Gambar tidak digunakan untuk membuat instance ECS.
IsSelfShared String true

Menunjukkan apakah custom image dibagikan ke akun Alibaba Cloud lain.

Description String Archive log for Oracle

Deskripsi gambar.

Size Integer 60

Ukuran gambar. Satuan: GiB.

ResourceGroupId String rg-bp67acfmxazb4p****

ID kelompok sumber daya tempat gambar berada.

Platform String Windows Server 2016

Sistem operasi.

OSNameEn String Windows Server 2016 Data Center Edition 64bit Chinese Edition

Nama tampilan sistem operasi dalam bahasa Inggris.

ImageName String testImageName

Nama gambar.

OSName String Windows Server 2016 Datacenter 64-bit (Simplified Chinese)

Nama tampilan sistem operasi dalam bahasa Tiongkok.

ImageId String m-bp1g7004ksh0oeuc****

ID gambar.

OSType String windows

Tipe sistem operasi. Nilai yang valid:

  • windows
  • linux
IsSubscribed Boolean false

Menunjukkan apakah Anda menerima Ketentuan Layanan layanan gambar yang sesuai dengan kode produk.

ProductCode String test000****

Kode produk Alibaba Cloud Marketplace gambar.

Architecture String x86_64

Arsitektur gambar. Nilai yang valid:

  • i386
  • x86_64
  • arm64
BootMode String BIOS

Mode boot gambar. Nilai yang valid:

  • BIOS
  • UEFI
DiskDeviceMappings Array of DiskDeviceMapping

Pemetaan antara disk dan snapshot dalam gambar.

DiskDeviceMapping
Type String system

Tipe gambar.

ImportOSSBucket String testEcsImport

Bucket Object Storage Service (OSS) yang berisi file gambar yang diimpor.

Progress String 32%

Progres tugas penyalinan gambar.

SnapshotId String s-bp17ot2q7x72ggtw****

ID snapshot.

ImportOSSObject String imageImport

Obyek OSS yang sesuai dengan file gambar yang diimpor.

Device String /dev/xvda

Nama perangkat disk. Contoh: /dev/xvdb.

Catatan Parameter ini akan dihapus di masa mendatang. Untuk memastikan kompatibilitas, kami menyarankan agar Anda menggunakan parameter lain.
Size String 60

Ukuran disk. Satuan: GiB.

RemainTime Integer 233

Sisa waktu tugas penyalinan gambar. Satuan: detik.

Format String qcow2

Format gambar.

Tags Array of Tag

Tag gambar.

Tag
TagValue String Oracle

Nilai tag gambar.

TagKey String DTS

Kunci tag gambar.

IsPublic Boolean false

Menunjukkan apakah gambar tersedia secara publik. Gambar yang tersedia secara publik mencakup public image yang disediakan oleh Alibaba Cloud dan custom image yang dipublikasikan sebagai community image. Nilai yang valid:

  • true: Gambar tersedia secara publik.
  • false: Gambar tidak tersedia secara publik.
ImageOwnerId Long 1234567890

ID akun Alibaba Cloud pemilik gambar. Parameter ini hanya berlaku jika Anda menanyakan shared image atau community image.

LoginAsNonRootSupported Boolean false

Menunjukkan apakah gambar mendukung login pengguna non-root. Nilai yang valid:

  • true
  • false
SupplierName String TestName

Nama pemasok yang mempublikasikan community image.

DetectionOptions Object

Detail pemeriksaan yang dilakukan pada gambar.

Status String Processing

Status tugas pemeriksaan gambar. Nilai yang valid:

  • Processing
  • Finished
Items Array of Item

Item pemeriksaan.

Item
Name String Nvme

Nama item pemeriksaan.

Value String Supported

Hasil item pemeriksaan.

RiskLevel String High

Tingkat keparahan risiko yang dimiliki item pemeriksaan pada custom image yang diimpor. Jika item pemeriksaan berisiko, parameter ini dikembalikan. Jika item pemeriksaan tidak berisiko, parameter ini tidak dikembalikan.

Nilai yang valid:

  • High: Item pemeriksaan merupakan item berisiko tinggi yang dapat memengaruhi startup instans. Kami menyarankan agar Anda menangani risiko tersebut.
  • Medium: Item pemeriksaan merupakan item berisiko menengah yang dapat memengaruhi performa startup atau konfigurasi instans. Kami menyarankan agar Anda menangani risiko tersebut.
RiskCode String NVMe.NotInstalled

Risiko yang mungkin dimiliki item pemeriksaan.

Features Object

Atribut gambar.

NvmeSupport String supported

Menunjukkan apakah gambar mendukung protokol Non-Volatile Memory Express (NVMe). Nilai yang valid:

  • supported: Gambar mendukung protokol NVMe. Instans yang dibuat dari gambar ini juga mendukung protokol NVMe.
  • unsupported: Gambar tidak mendukung protokol NVMe. Instans yang dibuat dari gambar ini tidak mendukung protokol NVMe.

Contoh

Contoh permintaan

http(s)://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&<Common request parameters>

Contoh respons sukses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeImagesResponse>
    <TotalCount>1</TotalCount>
    <PageSize>1</PageSize>
    <RequestId>66189103-EDB2-43E2-BB60-BFF2B62F4EB8</RequestId>
    <PageNumber>1</PageNumber>
    <Images>
        <Image>
            <ImageOwnerAlias>self</ImageOwnerAlias>
            <IsSelfShared>true</IsSelfShared>
            <Description>Archive log for Oracle</Description>
            <Platform>Windows Server 2016</Platform>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <Size>60</Size>
            <IsSubscribed>false</IsSubscribed>
            <BootMode>BIOS</BootMode>
            <OSName>Windows Server 2016 Datacenter 64-bit (Simplified Chinese)</OSName>
            <IsPublic>false</IsPublic>
            <ImageId>m-bp1g7004ksh0oeuc****</ImageId>
            <DetectionOptions/>
            <Features>
                <NvmeSupport>supported</NvmeSupport>
            </Features>
            <OSNameEn>Windows Server 2016 Data Center Edition 64bit Chinese Edition</OSNameEn>
            <Tags>
                <Tag>
                    <TagKey>DTS</TagKey>
                    <TagValue>Oracle</TagValue>
                </Tag>
            </Tags>
            <LoginAsNonRootSupported>false</LoginAsNonRootSupported>
            <Status>Available</Status>
            <Progress>100%</Progress>
            <Usage>none</Usage>
            <Architecture>x86_64</Architecture>
            <ProductCode>test000****</ProductCode>
            <IsCopied>false</IsCopied>
            <ImageFamily>hangzhou-daily-update</ImageFamily>
            <IsSupportIoOptimized>true</IsSupportIoOptimized>
            <IsSupportCloudinit>true</IsSupportCloudinit>
            <ImageName>testImageName</ImageName>
            <DiskDeviceMappings>
                <DiskDeviceMapping>
                    <SnapshotId>s-bp17ot2q7x72ggtw****</SnapshotId>
                    <Type>system</Type>
                    <Progress>32%</Progress>
                    <Format>qcow2</Format>
                    <Device>/dev/xvda</Device>
                    <Size>60</Size>
                    <ImportOSSBucket>testEcsImport</ImportOSSBucket>
                    <ImportOSSObject>imageImport</ImportOSSObject>
                </DiskDeviceMapping>
            </DiskDeviceMappings>
            <ImageVersion>2</ImageVersion>
            <OSType>windows</OSType>
            <CreationTime>2019-11-15T06:07:05Z</CreationTime>
        </Image>
    </Images>
    <RegionId>cn-hangzhou</RegionId>
</DescribeImagesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 1,
  "RequestId" : "66189103-EDB2-43E2-BB60-BFF2B62F4EB8",
  "PageNumber" : 1,
  "Images" : {
    "Image" : [ {
      "ImageOwnerAlias" : "self",
      "IsSelfShared" : "true",
      "Description" : "Archive log for Oracle",
      "Platform" : "Windows Server 2016",
      "ResourceGroupId" : "rg-bp67acfmxazb4p****",
      "Size" : 60,
      "IsSubscribed" : false,
      "BootMode" : "BIOS",
      "OSName": "Windows Server 2016 Datacenter 64-bit (Simplified Chinese)",
      "IsPublic" : false,
      "ImageId" : "m-bp1g7004ksh0oeuc****",
      "DetectionOptions" : { },
      "Features" : {
        "NvmeSupport" : "supported"
      },
      "OSNameEn" : "Windows Server 2016 Data Center Edition 64bit Chinese Edition",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "DTS",
          "TagValue" : "Oracle"
        } ]
      },
      "LoginAsNonRootSupported" : false,
      "Status" : "Available",
      "Progress" : "100%",
      "Usage" : "none",
      "Architecture" : "x86_64",
      "ProductCode" : "test000****",
      "IsCopied" : false,
      "ImageFamily" : "hangzhou-daily-update",
      "IsSupportIoOptimized" : true,
      "IsSupportCloudinit" : true,
      "ImageName" : "testImageName",
      "DiskDeviceMappings" : {
        "DiskDeviceMapping" : [ {
          "SnapshotId" : "s-bp17ot2q7x72ggtw****",
          "Type" : "system",
          "Progress" : "32%",
          "Format" : "qcow2",
          "Device" : "/dev/xvda",
          "Size" : "60",
          "ImportOSSBucket" : "testEcsImport",
          "ImportOSSObject" : "imageImport"
        } ]
      },
      "ImageVersion" : "2",
      "OSType" : "windows",
      "CreationTime" : "2019-11-15T06:07:05Z"
    } ]
  },
  "RegionId" : "cn-hangzhou"
}

Kode Kesalahan

Kode status HTTP

Kode kesalahan

Pesan kesalahan

Deskripsi

400 InvalidImageOwnerAlias.ValueNotSupported The specified ImageOwnerAlias value is not supported. Nilai ImageOwnerAlias tidak valid.
400 InvalidParamter Invalid Parameter. Nilai parameter tidak valid.
400 InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. Nilai Tag.N.Key dan Tag.N.Value tidak sesuai satu sama lain.
400 InvalidTagCount The specified tags are beyond the permitted range. Jumlah maksimum tag yang ditentukan telah terlampaui.
400 InvalidInstanceType.ValueNotSupported The specified InstanceType does not exist or beyond the permitted range. Tipe instans yang ditentukan tidak ditemukan atau Anda tidak memiliki izin untuk mengelola instans dengan tipe instans tersebut.
403 CurrentAccount.NotSupportPublicImage Public image is not supported for current account. Akun saat ini tidak dapat menggunakan public image.
404 InvalidFilterKey.NotFound The specified Filter Key is not found. Nilai Filter.N.Key tidak valid.
404 InvalidFilterValue The specified Filter Value is not valid. Nilai Filter.N.Value tidak valid.
404 InvalidUsage The specified Usage is not valid. Nilai Usage tidak valid.
404 InvalidOSType The specified OSType is not valid. Nilai OSType tidak valid.
404 InvalidArchitecture The specified Architecture is not valid. Nilai Architecture tidak valid.
500 InternalError The request processing has failed due to some unknown error. Terjadi kesalahan internal. Coba lagi nanti.

Untuk daftar kode kesalahan, lihat Kode kesalahan layanan.