DescribeImageComponents - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri detail satu atau beberapa komponen image.

Deskripsi operasi

Anda dapat mengatur NextToken ke nilai NextToken yang dikembalikan oleh panggilan sebelumnya ke DescribeImageComponents, dan mengatur MaxResults untuk menentukan jumlah entri maksimum 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:DescribeImageComponents

get

*ImageComponent

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

*ImageComponent

acs:ecs:{#regionId}:{#accountId}:imagecomponent/{#imagecomponentId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
ResourceGroupId	string	No	ID kelompok sumber daya. Jika Anda menggunakan parameter ini untuk memfilter resource, jumlah resource tidak boleh melebihi 1.000. Catatan Pemfilteran berdasarkan kelompok sumber daya default tidak didukung.	rg-bp67acfmxazb4p****
Tag	array<object>	No	Tag.
	object	No
Key	string	No	Kunci tag. Nilai valid N: 1 hingga 20.	TestKey
Value	string	No	Nilai tag. Nilai valid N: 1 hingga 20.	TestValue
Name	string	No	ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	testComponent
NextToken	string	No	ID kelompok sumber daya. Jika Anda menggunakan parameter ini untuk memfilter resource, jumlah resource tidak boleh melebihi 1.000. Catatan Pemfilteran berdasarkan kelompok sumber daya default tidak didukung.	AAAAAdDWBF2****
MaxResults	integer	No	Nama komponen image. Hanya pencocokan tepat yang didukung.	50
Owner	string	No	Token paginasi. Atur parameter ini ke nilai NextToken yang dikembalikan oleh panggilan sebelumnya. Anda tidak perlu mengatur parameter ini untuk permintaan pertama.	SELF
ImageComponentId	array	No	Jumlah entri maksimum per halaman untuk paginasi. Nilai valid: 1 hingga 500. Nilai default: 50.	ic-bp67acfmxazb4p****
	string	No	ID komponen image yang akan dikueri. Nilai N yang valid: 1 hingga 20.	ic-bp67acfmxazb4p****
ComponentType	string	No	Tipe komponen image. Nilai valid: SELF: komponen gambar kustom yang Anda buat. ALIYUN: komponen sistem yang disediakan oleh Alibaba Cloud.	Build
SystemType	string	No	ID komponen image yang akan dikueri. Nilai valid N: 1 hingga 20.	Linux
ComponentVersion	string	No	Tipe komponen. Nilai valid: Build Test.	1.0.*
		No	Sistem operasi yang didukung oleh komponen. Nilai valid: Linux Windows.
		No	Nomor versi komponen dalam format major.minor.patch. Setiap bagian harus berupa bilangan bulat non-negatif. Anda juga dapat menggunakan karakter wildcard () untuk mengganti satu bagian guna pencocokan fuzzy. Catatan* Parameter ini hanya berlaku ketika Name ditentukan.

Elemen respons

Element	Type	Description	Example
	object
NextToken	string	Token paginasi yang dikembalikan dalam panggilan ini. Untuk informasi selengkapnya tentang cara menggunakan token ini, lihat deskripsi operasi.	AAAAAdDWBF2****
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Jumlah total komponen image yang dikembalikan.	1
MaxResults	integer	Jumlah entri maksimum per halaman untuk paginasi.	50
ImageComponent	object
ImageComponentSet	array<object>	Daftar detail komponen image.
	array<object>
CreationTime	string	Waktu ketika komponen dibuat.	2020-11-24T06:00:00Z
Description	string	Deskripsi.	This is description.
SystemType	string	Sistem operasi yang didukung oleh komponen.	Linux
ImageComponentId	string	ID komponen image.	ic-bp67acfmxazb4p****
ComponentType	string	Jenis komponen.	Build
ResourceGroupId	string	ID grup sumber daya.	rg-bp67acfmxazb4p****
Name	string	Nama komponen.	testComponent
Content	string	Konten komponen.	Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world
Owner	string	Jenis komponen image. Nilai yang valid: SELF: komponen image kustom yang Anda buat. ALIYUN: komponen sistem yang disediakan oleh Alibaba Cloud.	SELF
Tags	object
Tag	array<object>	Daftar pasangan kunci-nilai tag.
	object
TagValue	string	Nilai tag.	TestValue
TagKey	string	Kunci tag.	TestKey
ComponentVersion	string	Nomor versi komponen.	1.0.0
Parameters	object
Parameter	array<object>	Daftar parameter yang termasuk dalam komponen image.
	object
Name	string	Nama parameter.	paramName
Type	string	Jenis parameter. Nilai yang valid: String Number Boolean.	String
DefaultValue	string	Nilai default parameter.	paramDefaultValue

Contoh

Respons sukses

JSONformat

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImageComponent": {
    "ImageComponentSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "Description": "This is description.",
        "SystemType": "Linux",
        "ImageComponentId": "ic-bp67acfmxazb4p****",
        "ComponentType": "Build",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Name": "testComponent",
        "Content": "Tasks:\n  - Name: HelloWorld\n    Action: RunShellCommand\n    Properties:\n      commandContent: echo hello world\n",
        "Owner": "SELF",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ComponentVersion": "1.0.0",
        "Parameters": {
          "Parameter": [
            {
              "Name": "paramName",
              "Type": "String",
              "DefaultValue": "paramDefaultValue"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidParameter.Owner	The specified parameter \"Owner\" is not valid.
400	InvalidImageComponentIdSize.ExceededMaxNumber	%s
400	InvalidSystemType.NotSupportedValue	%s.
400	InvalidComponentType.NotSupportedValue	%s.
400	InvalidParameter.ComponentVersion	The specified ComponentVersion is invalid.
403	Invalid.NextToken	The specified NextToken is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.