Gunakan ListCustomImages untuk kueri image kustom - Simple Application Server - Alibaba Cloud - Simple Application Server

Mengkueri informasi tentang gambar kustom di suatu Wilayah.

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

swas-open:ListCustomImages

get

*CustomImage

acs:swas-open:{#regionId}:{#accountId}:customimage/*

*CustomImage

acs:swas-open:{#regionId}:{#accountId}:customimage/{#CustomImageId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID Wilayah server aplikasi sederhana yang bersesuaian dengan gambar kustom. Anda dapat memanggil operasi ListRegions untuk mengkueri daftar Wilayah terbaru.	cn-hangzhou
ClientToken	string	No	Token Klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan Klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Nilai ClientToken hanya dapat berisi karakter ASCII dan tidak boleh melebihi 64 karakter panjangnya. Untuk informasi selengkapnya, lihat Cara memastikan idempotensi.	123e4567-e89b-12d3-a456-426655440000
ImageIds	string	No	ID gambar server aplikasi sederhana. Nilainya dapat berupa array JSON yang terdiri dari hingga 100 ID gambar. Pisahkan beberapa ID gambar dengan koma (,).	["fe9c66133a9d4688872869726b52**", "794c230fd3e64ea19f83f4d7a0ad**"]
PageSize	integer	No	Jumlah entri per halaman. Nilai maksimum: 100. Nilai default: 10.	10
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
ImageNames	string	No	Nama gambar server aplikasi sederhana. Nilainya dapat berupa array JSON yang terdiri dari hingga 100 nama gambar. Pisahkan beberapa nama gambar dengan koma (,).	["test1**", "test2**"]
SystemSnapshotId	string	No	ID Snapshot disk sistem.	s-bp14m09pq8***0g6
DataSnapshotId	string	No	ID Snapshot disk data.	s-acscasca****
Tag	array<object>	No	Tag N dari gambar kustom.
	object	No	The tags of the custom image.
Key	string	No	The key of tag N. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.	TestKey
Value	string	No	The value of tag N. A tag value can be up to 64 characters in length. Valid values of N: 1 to 20.	TestValue
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-aek2bti7cf7yj2i
Share	boolean	No	Apakah akan mengkueri gambar yang dibagikan. Nilai valid: False: Tidak mengkueri gambar yang dibagikan. Gambar yang dibagikan tidak disertakan dalam tanggapan. True: Mengkueri gambar yang dibagikan. Gambar yang dibagikan disertakan dalam tanggapan. Jika Anda tidak menentukan parameter ini, semua gambar akan dikembalikan.	False
InstanceId	string	No	ID server aplikasi sederhana asal gambar tersebut.	ace0706b2ac4454d984295a94213****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
CustomImages	array<object>	The array of queried custom images.
	array<object>	The information about the array object.
CreationTime	string	The time when the snapshot was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2022-10-09T02:28:06Z
DataSnapshotName	string	The name of the data disk snapshot.	数据盘快照
SystemSnapshotId	string	The ID of the system disk snapshot.	s-bp1h173hj21puxb***
InShare	boolean	Indicates whether the custom image is shared to Elastic Compute Service (ECS).	false
InShareUser	boolean	Indicates whether the custom image is shared across accounts.	False
InstanceId	string	The ID of the simple application server from which the image is derived.	2d06ee0520b44de1ae88d4be****
DataSnapshotId	string	The ID of the data disk snapshot.	s-bp19rn9u8eqzlfb***
RegionId	string	The region ID.	cn-hangzhou
SystemSnapshotName	string	The name of the system disk snapshot.	系统盘快照
Description	string	The description of the custom image.	自定义镜像-1
Name	string	The name of the custom image.	test
ImageId	string	The ID of the custom image.	m-bp1e79zktg26n2b***
Status	string	The status of the custom image. Valid values: 0: copying 1: available 2: unavailable 3: creation failed 4: creating	1
Tags	array<object>	The tags of the custom image.
	object	The tags of the custom image.
Key	string	The tag key of the custom image.	TestKey
Value	string	The tag value of the custom image.	TestValue
InstanceName	string	The name of the simple application server.	swas-asdf23***
ResourceGroupId	string	The ID of the resource group.	rg-acfm2h2lvp3ublq
CreateInstances	array	The simple application servers created from the image.
	string	The ID of the simple application server created from the image.	9ffb716db6ae406ca78a476c0c81****
UserId	integer	The ID of the Alibaba Cloud account to which the image belongs.	180185828710****
OsType	string	The operating system type of the image.	Linux
RequiredSystemDiskSize	integer	The size of the image system disk. Unit: GiB.	20
RequiredDataDiskSize	integer	The size of the image data disk. Unit: GiB.	20
SourceImageName	string	The name of the source image that is used to create the simple application server.	CentOS
SourceImageVersion	string	The version of the source image that is used to create the simple application server.	8.0
TotalCount	string	The total number of entries returned.	4
PageSize	string	The number of entries per page.	10
PageNumber	string	The page number.	1

Contoh

Respons sukses

JSONformat

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "CustomImages": [
    {
      "CreationTime": "2022-10-09T02:28:06Z",
      "DataSnapshotName": "数据盘快照",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InShareUser": true,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "系统盘快照",
      "Description": "自定义镜像-1",
      "Name": "test",
      "ImageId": "m-bp1e79zktg26n2b***",
      "Status": "1",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "swas-asdf23***",
      "ResourceGroupId": "rg-acfm2h2lvp3ublq",
      "CreateInstances": [
        "9ffb716db6ae406ca78a476c0c81****"
      ],
      "UserId": 0,
      "OsType": "Linux",
      "RequiredSystemDiskSize": 20,
      "RequiredDataDiskSize": 20,
      "SourceImageName": "CentOS",
      "SourceImageVersion": "8.0"
    }
  ],
  "TotalCount": "4",
  "PageSize": "10",
  "PageNumber": "1"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.