ListEndpointGroups - Global Accelerator

Operasi ini mengambil daftar kelompok titik akhir.

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

ga:ListEndpointGroups

list

*EndpointGroup

acs:ga:{#regionId}:{#accountId}:endpointgroup/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah dari instans Alibaba Cloud Global Accelerator (GA). Tetapkan nilainya ke cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai maksimum: 50. Nilai default: 10.	10
AcceleratorId	string	Yes	ID instans GA.	ga-bp1odcab8tmno0hdq****
ListenerId	string	No	ID listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	No	Tipe kelompok titik akhir. Nilai yang valid: default: kelompok titik akhir default. virtual: kelompok titik akhir virtual. Jika Anda tidak mengisi parameter ini, kedua jenis kelompok titik akhir (default dan virtual) akan diambil.	virtual
AccessLogSwitch	string	No	Menentukan apakah fitur log akses diaktifkan. Nilai yang valid: on: mengaktifkan fitur log akses. off (default): menonaktifkan fitur log akses.	on
EndpointGroupId	string	No	ID kelompok titik akhir.	epg-bp16jdc00bhe97sr5****
Tag	array<object>	No	Tag kelompok titik akhir.
	object	No	Tag kelompok titik akhir.
Key	string	No	Kunci tag kelompok titik akhir. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag maksimal 64 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag juga tidak boleh mengandung `http://` atau `https://`. Anda dapat menentukan hingga 20 kunci tag.	test-key
Value	string	No	Nilai tag kelompok titik akhir. Nilai tag boleh berupa string kosong. Panjang nilai tag maksimal 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Nilai tag juga tidak boleh mengandung `http://` atau `https://`. Anda dapat menentukan hingga 20 nilai tag.	test-value

Elemen respons

Element	Type	Description	Example
	object	Daftar informasi yang dikembalikan.
TotalCount	integer	Total jumlah entri yang dikembalikan.	1
PageSize	integer	Jumlah entri per halaman.	10
RequestId	string	ID permintaan.	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	Nomor halaman.	1
EndpointGroups	array<object>	Konfigurasi kelompok titik akhir.
	array<object>	Konfigurasi kelompok titik akhir.
EndpointGroupId	string	ID kelompok titik akhir.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	Daftar alamat IP publik kelompok titik akhir.
	string	Daftar alamat IP publik kelompok titik akhir.	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	Daftar alamat IP kelompok titik akhir yang menunggu konfirmasi setelah instans GA ditingkatkan.
	string	Daftar alamat IP kelompok titik akhir yang menunggu konfirmasi setelah instans GA ditingkatkan.	47.1.XX.XX
State	string	Status kelompok titik akhir. init: Kelompok titik akhir sedang diinisialisasi. active: Kelompok titik akhir sedang berjalan. updating: Kelompok titik akhir sedang diperbarui. deleting: Kelompok titik akhir sedang dihapus.	active
HealthCheckPath	string	Jalur untuk pemeriksaan kesehatan.	/healthcheck
EndpointGroupRegion	string	ID wilayah tempat kelompok titik akhir ditempatkan.	cn-hangzhou
HealthCheckIntervalSeconds	integer	Interval antara dua pemeriksaan kesehatan berturut-turut. Satuan: detik.	3
TrafficPercentage	integer	Rasio distribusi trafik. Jika sebuah listener dikaitkan dengan beberapa kelompok titik akhir, trafik didistribusikan ke kelompok titik akhir tersebut berdasarkan rasio yang ditentukan.	100
HealthCheckProtocol	string	Protokol yang digunakan untuk pemeriksaan kesehatan. tcp atau TCP: TCP. http atau HTTP: HTTP. https atau HTTPS: HTTPS.	tcp
ThresholdCount	integer	Jumlah kegagalan pemeriksaan kesehatan berturut-turut yang harus terjadi sebelum suatu titik akhir dianggap tidak sehat.	3
ListenerId	string	ID listener.	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	ID instans GA.	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	Konfigurasi titik akhir.
	object	Konfigurasi titik akhir.
Type	string	Tipe titik akhir. Domain: nama domain kustom. Ip: alamat IP kustom. IpTarget: alamat IP pribadi kustom. PublicIp: alamat IP publik Alibaba Cloud. ECS: Instance ECS Alibaba Cloud. SLB: Instance SLB Alibaba Cloud. ALB: Instance ALB Alibaba Cloud. OSS: Bucket OSS Alibaba Cloud. ENI: elastic network interface (ENI) Alibaba Cloud. NLB: Instance NLB Alibaba Cloud.	Ip
EnableClientIPPreservation	boolean	Menunjukkan apakah fitur pelestarian alamat IP klien diaktifkan. true: Fitur pelestarian alamat IP klien diaktifkan. false: Fitur pelestarian alamat IP klien dinonaktifkan.	false
Weight	integer	Bobot titik akhir.	20
ProbeProtocol	string	Protokol yang digunakan untuk mengukur latensi. icmp: ICMP. tcp: TCP.	tcp
Endpoint	string	Alamat IP, nama domain, atau ID instans titik akhir.	47.1.XX.XX
EnableProxyProtocol	boolean	Menunjukkan apakah Proxy Protocol digunakan untuk melestarikan alamat IP klien. true: Proxy Protocol digunakan untuk melestarikan alamat IP klien. false: Proxy Protocol tidak digunakan untuk melestarikan alamat IP klien.
ProbePort	integer	Port yang digunakan untuk mengukur latensi.	80
EndpointId	string	ID titik akhir.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	Alamat IP pribadi ENI.	172.168.XX.XX
VpcId	string	ID virtual private cloud (VPC).	vpc-8vbhucmd5b2q2fpqqu****
VSwitchIds	array	Daftar vSwitch dalam VPC.
	string	ID vSwitch.	vsw-hp3xwc2aebg2u30ln****
PortOverrides	array<object>	Pemetaan port.
	object	Pemetaan port.
ListenerPort	integer	Port listener.	443
EndpointPort	integer	Port titik akhir.	80
ForwardingRuleIds	array	ID aturan pengalihan yang dikaitkan dengan kelompok titik akhir.
	string	ID aturan pengalihan yang dikaitkan dengan kelompok titik akhir.	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	Tipe kelompok titik akhir. default: kelompok titik akhir default. virtual: kelompok titik akhir virtual.	default
EndpointRequestProtocol	string	Protokol layanan backend. HTTP: HTTP. HTTPS: HTTPS.	HTTP
EndpointProtocolVersion	string	Versi protokol layanan backend. HTTP1.1: HTTP/1.1. HTTP2: HTTP/2.	HTTP1.1
Description	string	Deskripsi kelompok titik akhir.	group1
Name	string	Nama kelompok titik akhir.	group1
HealthCheckPort	integer	Port yang digunakan untuk pemeriksaan kesehatan.	10
HealthCheckEnabled	boolean	Menunjukkan apakah pemeriksaan kesehatan diaktifkan. true: Pemeriksaan kesehatan diaktifkan. false: Pemeriksaan kesehatan dinonaktifkan.	true
ServiceId	string	ID layanan yang dikaitkan dengan instans terkelola. Catatan Parameter ini hanya dikembalikan jika ServiceManaged diatur ke True.	ALB
ServiceManaged	boolean	Menunjukkan apakah instans merupakan instans terkelola. Nilai yang valid: true: Instans merupakan instans terkelola. false: Instans bukan instans terkelola.	true
ServiceManagedInfos	array<object>	Aksi yang dapat Anda lakukan pada instans terkelola. Catatan Parameter ini hanya dikembalikan jika ServiceManaged diatur ke True. Jika instans dikelola, Anda tidak dapat melakukan beberapa operasi pada instans tersebut.
	object	Aksi yang dapat Anda lakukan pada instans terkelola.
Action	string	Nama aksi pada instans terkelola. Create: membuat instans. Update: memperbarui instans saat ini. Delete: menghapus instans saat ini. Associate: mengaitkan instans dengan instans lain. UserUnmanaged: memutuskan kaitan instans dari layanan. CreateChild: membuat sumber daya turunan dalam instans.	Update
ChildType	string	Tipe sumber daya turunan. Listener: listener. IpSet: wilayah akselerasi. EndpointGroup: kelompok titik akhir. ForwardingRule: aturan pengalihan. Endpoint: titik akhir. EndpointGroupDestination: pemetaan protokol kelompok titik akhir yang dikaitkan dengan listener routing kustom. EndpointPolicy: kebijakan trafik titik akhir yang dikaitkan dengan listener routing kustom. Catatan Parameter ini hanya dikembalikan jika Action diatur ke CreateChild.	Listener
IsManaged	boolean	Menunjukkan apakah aksi yang ditentukan dikelola. Nilai yang valid: true: Aksi yang ditentukan dikelola. Anda tidak dapat melakukan aksi tersebut pada instans terkelola. false: Aksi yang ditentukan tidak dikelola. Anda dapat melakukan aksi tersebut pada instans terkelola.	false
Tags	array<object>	Tag kelompok titik akhir.
	object	Tag kelompok titik akhir.
Key	string	Kunci tag kelompok titik akhir.	test-key
Value	string	Nilai tag kelompok titik akhir.	test-value
HealthCheckHost	string	Nama domain yang digunakan untuk pemeriksaan kesehatan.	www.taobao.com
EndpointIpVersion	string	Protokol IP layanan backend. Nilai yang valid: IPv4 (default): GA berkomunikasi dengan layanan titik akhir menggunakan alamat IPv4. IPv6: GA berkomunikasi dengan layanan titik akhir menggunakan alamat IPv6. ProtocolAffinity: Protokol IP yang digunakan GA untuk berkomunikasi dengan layanan titik akhir sama dengan protokol IP yang digunakan klien untuk mengirim permintaan.	IPv4
EndpointPrivateIpList	array<object>	Daftar alamat IP pribadi layanan backend.
	object
PrivateIp	string	Alamat IP pribadi.	172.19.115.37
VSwitchId	string	ID vSwitch dalam VPC.	gsw-0jl6tmriqep1ga***
CIDR	string

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "A052D49E-CCC2-41DB-816C-DC3381503194\t",
  "PageNumber": 1,
  "EndpointGroups": [
    {
      "EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
      "EndpointGroupIpList": [
        "47.1.XX.XX"
      ],
      "EndpointGroupUnconfirmedIpList": [
        "47.1.XX.XX"
      ],
      "State": "active",
      "HealthCheckPath": "/healthcheck",
      "EndpointGroupRegion": "cn-hangzhou",
      "HealthCheckIntervalSeconds": 3,
      "TrafficPercentage": 100,
      "HealthCheckProtocol": "tcp",
      "ThresholdCount": 3,
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "EndpointConfigurations": [
        {
          "Type": "Ip",
          "EnableClientIPPreservation": false,
          "Weight": 20,
          "ProbeProtocol": "tcp",
          "Endpoint": "47.1.XX.XX",
          "EnableProxyProtocol": false,
          "ProbePort": 80,
          "EndpointId": "ep-bp1d2utp8qqe2a44t****",
          "SubAddress": "172.168.XX.XX",
          "VpcId": "vpc-8vbhucmd5b2q2fpqqu****",
          "VSwitchIds": [
            "vsw-hp3xwc2aebg2u30ln****"
          ]
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "EndpointGroupType": "default",
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "HTTP1.1",
      "Description": "group1",
      "Name": "group1",
      "HealthCheckPort": 10,
      "HealthCheckEnabled": true,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "Tags": [
        {
          "Key": "test-key",
          "Value": "test-value"
        }
      ],
      "HealthCheckHost": "www.taobao.com",
      "EndpointIpVersion": "IPv4",
      "EndpointPrivateIpList": [
        {
          "PrivateIp": "172.19.115.37",
          "VSwitchId": "gsw-0jl6tmriqep1ga***",
          "CIDR": ""
        }
      ]
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	NoPermission	No permissions.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.