Gunakan ListEdgeContainerApps untuk mengkueri aplikasi kontainer edge - Edge Security Acceleration

Menampilkan semua aplikasi terkontainerisasi dalam Akun Alibaba Cloud Anda.

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

esa:ListEdgeContainerApps

none

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman. Nilai default: 1. Nilai yang valid: 1 hingga 65535.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 20. Nilai yang valid: 1 hingga 500.	20
OrderKey	string	No	Bidang pengurutan. Parameter ini dikosongkan secara default. Nilai yang valid: Name: nama versi. CreateTime: waktu pembuatan versi. UpdateTime: waktu modifikasi terakhir versi.	CreateTime
OrderType	string	No	Urutan pengurutan hasil kueri. Parameter ini dikosongkan secara default. Nilai yang valid: ASC: urutan menaik. DESC: urutan menurun.	Asc
SearchType	string	No	Kriteria pencarian berdasarkan mana Anda ingin melakukan pencarian fuzzy. Nilai yang valid: Appid: ID aplikasi. Name: nama aplikasi.	AppId
SearchKey	string	No	Kata kunci pencarian.	ver-1005682639679266816

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	2430E05E-1340-5773-B5E1-B743929F46F2
PageNumber	integer	Nomor halaman. Nilai default: 1. Nilai yang valid: 1 hingga 65535.	1
PageSize	integer	Jumlah entri per halaman. Nilai yang valid: 1 hingga 500.	10
TotalCount	integer	Jumlah total entri.	10
Apps	array<object>	Aplikasi yang ditanyakan.
	array<object>	Aplikasi yang ditanyakan.
Status	string	Status aplikasi. Nilai yang valid: creating: Aplikasi sedang dibuat. failed: Pembuatan aplikasi gagal. created: Aplikasi telah dibuat.	created
GatewayType	string	Tipe gerbang. Nilai yang valid: l7: Layer 7 gateway. l4: Layer 4 gateway.	l7
CreateTime	string	Waktu pembuatan versi.	2022-12-01T16:16:27.418298794+08:00
VersionCount	integer	Jumlah versi aplikasi.	10
DomainName	string	Nama domain yang terkait dengan aplikasi.	test.com
Remarks	string	Catatan.	test app
ServicePort	integer	Port server. Nilai yang valid: 1 hingga 65535.	80
AppId	string	ID aplikasi.	app-88068867578379****
TargetPort	integer	Port backend, yang juga merupakan port layanan aplikasi. Nilai yang valid: 1 hingga 65535.	80
QuicCid	string	Menunjukkan apakah QUIC diaktifkan.	false
Name	string	Nama aplikasi.	app-test
UpdateTime	string	Waktu modifikasi terakhir aplikasi. Waktu mengikuti standar ISO 8601 dalam format YYYY-MM-DDThh:mm:ss. Waktu ditampilkan dalam UTC.	2023-11-15T12:11:02Z
HealthCheck	object	Informasi tentang pemeriksaan kesehatan.
Timeout	integer	Periode timeout pemeriksaan kesehatan. Satuan: detik.	60
Type	string	Tipe pemeriksaan kesehatan. Nilai yang valid: l7 l4	l7
Host	string	Nama domain yang digunakan untuk pemeriksaan kesehatan.	test.com
Interval	integer	Interval antar pemeriksaan kesehatan. Satuan: detik.	5
SuccTimes	integer	Jumlah pemeriksaan kesehatan sukses berturut-turut agar aplikasi dianggap sehat.	1
Method	string	Metode HTTP yang digunakan untuk pemeriksaan kesehatan.	GET
HttpCode	string	Rentang kode status pemeriksaan kesehatan yang menunjukkan pemeriksaan kesehatan berhasil.	http_2XX
FailTimes	integer	Jumlah pemeriksaan kesehatan gagal berturut-turut agar aplikasi dianggap tidak sehat.	5
Port	integer	Port pemeriksaan kesehatan.	8080
Uri	string	URL pemeriksaan kesehatan.	/health_check
Percentage	integer	Progres task pembuatan aplikasi dalam persentase.	100

Contoh

Respons sukses

JSONformat

{
  "RequestId": "2430E05E-1340-5773-B5E1-B743929F46F2",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10,
  "Apps": [
    {
      "Status": "created",
      "GatewayType": "l7",
      "CreateTime": "2022-12-01T16:16:27.418298794+08:00",
      "VersionCount": 10,
      "DomainName": "test.com",
      "Remarks": "test app",
      "ServicePort": 80,
      "AppId": "app-88068867578379****",
      "TargetPort": 80,
      "QuicCid": "false",
      "Name": "app-test",
      "UpdateTime": "2023-11-15T12:11:02Z",
      "HealthCheck": {
        "Timeout": 60,
        "Type": "l7",
        "Host": "test.com",
        "Interval": 5,
        "SuccTimes": 1,
        "Method": "GET",
        "HttpCode": "http_2XX",
        "FailTimes": 5,
        "Port": 8080,
        "Uri": "/health_check"
      },
      "Percentage": 100
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidParameter.OrderType	The specified OrderType is invalid. Please check the OrderType parameter. You may not have set it to either Asc or Desc. Please make the necessary changes and call the interface again.
400	InvalidParameter.OrderKey	The specified OrderKey is invalid. Please check the OrderKey parameter.
400	InvalidParameter	Invalid parameter. Check the parameter configuration.
400	InvalidParameter.PageNumber	Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.
400	InvalidParameter.appid	The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.
400	InvalidPageSize.ValueNotSupported	The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500.
500	InternalError	Failed to call the service. Try again later or contact technical support.
404	InvalidApp.NotFound	The application does not exist. Check whether the application ID you specified is correct and try again.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.