DescribeImagePipelines - Elastic Compute Service - Alibaba Cloud Documentation Center

Menjelaskan satu atau beberapa templat gambar.

Deskripsi operasi

Untuk menavigasi halaman hasil, atur parameter NextToken ke nilai NextToken dari respons DescribeImagePipelines sebelumnya dan gunakan MaxResults untuk membatasi jumlah hasil per halaman.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeImagePipelines

get

*ImagePipeline

acs:ecs:{#regionId}:{#accountId}:imagepipeline/*

*ImagePipeline

acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri wilayah Alibaba Cloud terbaru.	cn-hangzhou
ResourceGroupId	string	No	ID kelompok sumber daya enterprise. Saat Anda menggunakan parameter ini untuk memfilter resource, kueri akan mengembalikan maksimal 1.000 resource. Catatan Anda tidak dapat melakukan filter berdasarkan kelompok sumber daya default.	rg-bp67acfmxazb4p****
Tag	array<object>	No	Daftar tag.
	object	No	Objek tag.
Key	string	No	Kunci tag N. Anda dapat menentukan hingga 20 tag.	TestKey
Value	string	No	Nilai tag N. Anda dapat menentukan hingga 20 tag.	TestValue
RegionId	string	Yes	ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri wilayah Alibaba Cloud terbaru.	cn-hangzhou
ResourceGroupId	string	No	ID kelompok sumber daya enterprise. Saat Anda menggunakan parameter ini untuk memfilter resource, kueri akan mengembalikan maksimal 1.000 resource. Catatan Anda tidak dapat melakukan filter berdasarkan kelompok sumber daya default.	rg-bp67acfmxazb4p****
Name	string	No	Nama pipeline gambar.	testImagePipeline
NextToken	string	No	Token untuk halaman hasil berikutnya. Untuk mengambil halaman berikutnya, atur parameter ini ke nilai NextToken dari respons sebelumnya. Abaikan parameter ini untuk permintaan pertama.	AAAAAdDWBF2****
MaxResults	integer	No	Jumlah maksimum entri yang dikembalikan per halaman. Nilai valid: 1 hingga 500. Nilai default: 50.	50
ImagePipelineId	array	No	ID pipeline gambar. Anda dapat menentukan hingga 20 ID.	ip-2ze5tsl5bp6nf2b3****
	string	No	ID pipeline gambar.	ip-2ze5tsl5bp6nf2b3****

Elemen respons

Element	Type	Description	Example
	object
NextToken	string	Token pagination yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Untuk informasi lebih lanjut, lihat bagian "Catatan penggunaan".	AAAAAdDWBF2****
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Jumlah total templat gambar.	1
MaxResults	integer	Jumlah entri per halaman.	50
ImagePipeline	object
ImagePipelineSet	array<object>	Detail templat gambar.
	array<object>
CreationTime	string	Waktu saat templat gambar dibuat.	2020-11-24T06:00:00Z
DeleteInstanceOnFailure	boolean	Menunjukkan apakah instans perantara akan dilepas ketika pembuatan gambar gagal.	true
InstanceType	string	Tipe instans.	ecs.g6.large
InternetMaxBandwidthOut	integer	Bandwidth egress publik dari instans perantara. Satuan: Mbit/s.	0
ImagePipelineId	string	ID templat gambar.	ip-2ze5tsl5bp6nf2b3****
VSwitchId	string	ID vSwitch.	vsw-bp67acfmxazb4p****
SystemDiskSize	integer	Ukuran disk sistem dari instans perantara. Satuan: GiB.	40
Description	string	Deskripsi templat gambar.	This is description.
BaseImage	string	Gambar sumber. Jika `BaseImageType` diatur ke `IMAGE`, nilai parameter ini adalah ID gambar kustom. Jika `BaseImageType` diatur ke `IMAGE_FAMILY`, nilai parameter ini adalah nama keluarga gambar.	m-bp67acfmxazb4p****
ResourceGroupId	string	ID kelompok sumber daya.	rg-bp67acfmxazb4p****
ImageName `deprecated`	string	Awalan nama gambar tujuan. Penting Parameter ini sudah tidak digunakan lagi. Gunakan `ImageOptions.ImageName` sebagai gantinya.	testImageName
BaseImageType	string	Jenis gambar sumber. Nilai valid: IMAGE: gambar kustom IMAGE_FAMILY: keluarga gambar	IMAGE
Name	string	Nama templat.	testImagePipeline
BuildContent	string	Konten templat gambar.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
Tags	object
Tag	array<object>	Tag.
	object
TagValue	string	Nilai tag.	TestValue
TagKey	string	Kunci tag.	TestKey
ToRegionIds	object
ToRegionId	array	ID wilayah tujuan.
	string	ID wilayah tujuan.	["cn-hangzhou"]
AddAccounts	object
AddAccount	array	ID Akun Alibaba Cloud yang akan diajak berbagi gambar.
	string	ID Akun Alibaba Cloud yang akan diajak berbagi gambar.	["1234567890"]
RepairMode	string	Opsi perbaikan dalam templat gambar. Nilai valid: Standard: mode standar	Standard
TestContent	string	Konten templat uji gambar.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
ImageFamily `deprecated`	string	Nama keluarga gambar tujuan. Penting Parameter ini sudah tidak digunakan lagi. Gunakan `ImageOptions.ImageFamily` sebagai gantinya.	family
NvmeSupport `deprecated`	string	Menunjukkan apakah gambar tujuan mendukung NVMe. Penting Parameter ini sudah tidak digunakan lagi. Gunakan `ImageOptions.ImageFeatures.NvmeSupport` sebagai gantinya.	auto
ImportImageOptions	object	Atribut dan pengaturan untuk mengimpor gambar.
Architecture	string	Arsitektur sistem. Nilai valid: x86_64 arm64	x86_64
OSType	string	Sistem operasi. Nilai valid: windows linux	linux
Platform	string	Distribusi sistem operasi. Nilai valid: Aliyun Anolis CentOS Ubuntu CoreOS SUSE Debian OpenSUSE FreeBSD RedHat Kylin UOS Fedora Fedora CoreOS CentOS Stream AlmaLinux Rocky Linux Gentoo Customized Linux Others Linux Windows Server 2022 Windows Server 2019 Windows Server 2016 Windows Server 2012 Windows Server 2008 Windows Server 2003 Other Windows	Aliyun
BootMode	string	Mode boot gambar. Nilai valid: BIOS UEFI	BIOS
LicenseType	string	Jenis lisensi yang digunakan untuk mengaktifkan sistem operasi setelah gambar diimpor. Nilai valid: Auto: Alibaba Cloud mendeteksi sistem operasi dari gambar sumber dan mengalokasikan lisensi. Dalam mode ini, sistem terlebih dahulu memeriksa apakah tersedia lisensi resmi Alibaba Cloud untuk sistem operasi yang ditentukan oleh `Platform`. Jika lisensi resmi tidak tersedia, sistem beralih ke mode Bring Your Own License (BYOL). Aliyun: menggunakan lisensi resmi Alibaba Cloud berdasarkan sistem operasi yang ditentukan oleh `Platform`. BYOL: menggunakan lisensi dari gambar sumber. Saat menggunakan mode BYOL, pastikan lisensi Anda didukung oleh Alibaba Cloud.	Auto
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	Informasi tentang gambar kustom. N=1 menunjukkan disk sistem. N dapat berupa bilangan bulat dari 2 hingga 17, yang menunjukkan disk data.
	object
OSSBucket	string	Bucket OSS tempat file gambar disimpan.	ecsimageos
OSSObject	string	Nama file gambar di bucket OSS.	CentOS_5.4_32.raw
Format	string	Format gambar. Nilai valid: RAW VHD QCOW2	RAW
DiskImageSize	integer	Ukuran gambar kustom setelah gambar diimpor. Ukuran terdiri dari ukuran disk sistem dan ukuran disk data. Pastikan ukuran disk sistem lebih besar atau sama dengan ukuran file gambar yang diimpor. Nilai valid: Ketika N adalah 1, yang menunjukkan disk sistem, nilainya berkisar antara 1 hingga 2.048. Satuan: GiB. Ketika N adalah bilangan bulat dari 2 hingga 17, yang menunjukkan disk data, nilainya berkisar antara 1 hingga 2.048. Satuan: GiB. Setelah Anda mengunggah file gambar sumber ke bucket OSS, Anda dapat melihat ukuran file gambar tersebut di bucket OSS.	40
Features	object	Atribut gambar.
NvmeSupport	string	Menunjukkan apakah gambar yang diimpor mendukung NVMe. Nilai valid: supported: Instans yang dibuat dari gambar ini mendukung protokol NVMe. unsupported: Instans yang dibuat dari gambar ini tidak mendukung protokol NVMe.	supported
ImdsSupport	string
RetainImportedImage	boolean	Catatan Parameter ini sedang dalam pratinjau undangan.	false
RetentionStrategy	string
ImageName	string
Description	string
RoleName	string
ImportImageTags	object
ImportImageTag	array<object>
	object
Key	string
Value	string
AdvancedOptions	object	Pengaturan lanjutan.
RetainCloudAssistant	boolean	Menunjukkan apakah Asisten Cloud akan dipertahankan. Selama proses build, sistem secara otomatis menginstal Asisten Cloud di instans perantara untuk menjalankan perintah. Anda dapat memilih apakah akan mempertahankan Asisten Cloud di gambar tujuan. Nilai valid: true: mempertahankan Asisten Cloud. false: tidak mempertahankan Asisten Cloud. Catatan Pengaturan ini tidak memengaruhi client Asisten Cloud yang sudah termasuk dalam gambar sumber Anda.	true
ImageNameSuffix	string	Menunjukkan apakah akan menonaktifkan sistem agar tidak secara otomatis menambahkan akhiran ke nama gambar tujuan. Nilai valid: disable: menonaktifkan sistem dari menambahkan akhiran.	disable
ImageOptions	object	Atribut gambar tujuan.
ImageName	string	Awalan nama gambar tujuan.	imageName
ImageFamily	string	Nama keluarga gambar tujuan.	family
Description	string	Deskripsi gambar tujuan.	description.
ImageFeatures	object	Atribut gambar tujuan.
NvmeSupport	string	Menunjukkan apakah gambar tujuan mendukung NVMe. Nilai valid: supported: Instans yang dibuat dari gambar ini mendukung protokol NVMe. unsupported: Instans yang dibuat dari gambar ini tidak mendukung protokol NVMe. auto: Sistem secara otomatis memeriksa apakah gambar sumber memiliki driver NVMe yang terinstal. Pemeriksaan ini dilakukan sebelum fase build. Jika driver NVMe diinstal atau di-uninstall selama build, deteksi mungkin tidak akurat. Dalam kasus seperti itu, atur parameter ini ke `supported` atau `unsupported` berdasarkan konten build.	auto
ImageTags	object
ImageTag	array<object>	Tag gambar tujuan.
	object
TagKey	string	Kunci tag.	testKey
TagValue	string	Nilai tag.	testValue

Contoh

Respons sukses

JSONformat

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImagePipeline": {
    "ImagePipelineSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "DeleteInstanceOnFailure": true,
        "InstanceType": "ecs.g6.large",
        "InternetMaxBandwidthOut": 0,
        "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
        "VSwitchId": "vsw-bp67acfmxazb4p****",
        "SystemDiskSize": 40,
        "Description": "This is description.",
        "BaseImage": "m-bp67acfmxazb4p****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ImageName": "testImageName",
        "BaseImageType": "IMAGE",
        "Name": "testImagePipeline",
        "BuildContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "RepairMode": "Standard",
        "TestContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "ImageFamily": "family",
        "NvmeSupport": "auto",
        "ImportImageOptions": {
          "Architecture": "x86_64",
          "OSType": "linux",
          "Platform": "Aliyun",
          "BootMode": "BIOS",
          "LicenseType": "Auto",
          "DiskDeviceMappings": {
            "DiskDeviceMapping": [
              {
                "OSSBucket": "ecsimageos",
                "OSSObject": "CentOS_5.4_32.raw",
                "Format": "RAW",
                "DiskImageSize": 40
              }
            ]
          },
          "Features": {
            "NvmeSupport": "supported",
            "ImdsSupport": ""
          },
          "RetainImportedImage": false,
          "RetentionStrategy": "",
          "ImageName": "",
          "Description": "",
          "RoleName": "",
          "ImportImageTags": {
            "ImportImageTag": [
              {
                "Key": "",
                "Value": ""
              }
            ]
          }
        },
        "AdvancedOptions": {
          "RetainCloudAssistant": true,
          "ImageNameSuffix": "disable"
        },
        "ImageOptions": {
          "ImageName": "imageName",
          "ImageFamily": "family",
          "Description": "description.",
          "ImageFeatures": {
            "NvmeSupport": "auto"
          },
          "ImageTags": {
            "ImageTag": [
              {
                "TagKey": "testKey",
                "TagValue": "testValue"
              }
            ]
          }
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidImagePipelineIdSize.ExceededMaxNumber	%s
400	InvalidName.Malformed	%s
403	Invalid.NextToken	The specified NextToken is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.