Gunakan UpdateEndpointGroups - Global Accelerator - Alibaba Cloud - Global Accelerator

Memodifikasi grup endpoint untuk listener secara batch.

Deskripsi operasi

Catatan penggunaan

UpdateEndpointGroups adalah operasi asinkron. Setelah Anda mengirim permintaan, sistem mengembalikan ID permintaan, tetapi operasi terus berjalan di latar belakang. Anda dapat memanggil operasi atau untuk menanyakan status grup endpoint.
- Jika grup endpoint berada dalam status updating, konfigurasinya sedang dimodifikasi. Dalam status ini, Anda hanya dapat melakukan operasi kueri.
- Jika grup endpoint berada dalam status active, konfigurasinya telah dimodifikasi.
Anda tidak dapat memanggil operasi UpdateEndpointGroups secara bersamaan untuk memodifikasi konfigurasi grup endpoint yang termasuk dalam instance Global Accelerator (GA) yang sama.

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:UpdateEndpointGroups

update

*EndpointGroup

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region dari instance GA. Atur nilainya menjadi cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Hasilkan nilai untuk parameter ini di klien Anda. Pastikan nilainya unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: melakukan dry run. Sistem memeriksa parameter yang diperlukan, format permintaan, dan batas layanan. Jika permintaan gagal dry run, pesan kesalahan dikembalikan. Jika permintaan lulus dry run, kode status HTTP 2xx dikembalikan. false (default): mengirimkan permintaan. Jika permintaan lulus pemeriksaan, kode status HTTP 2xx dikembalikan dan operasi dilakukan.	true
EndpointGroupConfigurations	array<object>	Yes	Konfigurasi grup endpoint.
	array<object>	No	Konfigurasi grup endpoint.
EndpointGroupName	string	No	Nama grup endpoint. Nama harus terdiri dari 1 hingga 128 karakter, diawali dengan huruf atau karakter Tionghoa, dan dapat berisi huruf, angka, titik (.), garis bawah (_), dan tanda hubung (-).	group1
EndpointGroupDescription	string	No	Deskripsi grup endpoint. Deskripsi dapat memiliki panjang hingga 200 karakter dan tidak boleh diawali dengan http:// atau https://.	group1
TrafficPercentage	integer	No	Rasio distribusi lalu lintas. Jika sebuah listener terhubung dengan beberapa grup endpoint, Anda dapat menentukan parameter ini untuk mendistribusikan lalu lintas ke grup endpoint tersebut. Nilai yang valid: 1 hingga 100.	20
HealthCheckEnabled	boolean	No	Menentukan apakah akan mengaktifkan fitur pemeriksaan kesehatan (health check). true: mengaktifkan fitur pemeriksaan kesehatan. false (default): menonaktifkan fitur pemeriksaan kesehatan.	true
HealthCheckIntervalSeconds	integer	No	Interval antara dua pemeriksaan kesehatan berturut-turut. Satuan: detik. Nilai yang valid: 1 hingga 50.	3
HealthCheckPath	string	No	Jalur (path) pemeriksaan kesehatan.	/healthcheck
HealthCheckPort	integer	No	Port yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: 1 hingga 65535.	20
HealthCheckProtocol	string	No	Protokol yang digunakan untuk pemeriksaan kesehatan. tcp atau TCP: TCP http atau HTTP: HTTP https atau HTTPS: HTTPS	tcp
ThresholdCount	integer	No	Jumlah pemeriksaan kesehatan berturut-turut yang harus dilewati oleh endpoint untuk dianggap sehat, atau gagal untuk dianggap tidak sehat. Nilai yang valid: 2 hingga 10.	3
EndpointConfigurations	array<object>	No	Konfigurasi endpoint.
	object	Yes	Konfigurasi endpoint.
Type	string	Yes	Tipe endpoint. Domain: nama domain kustom. Ip: alamat IP kustom. IpTarget: alamat IP privat kustom. PublicIp: alamat IP publik Alibaba Cloud. ECS: instance Elastic Compute Service (ECS) Alibaba Cloud. SLB: instance Server Load Balancer (SLB) Alibaba Cloud. ALB: instance Application Load Balancer (ALB) Alibaba Cloud. OSS: bucket Object Storage Service (OSS) Alibaba Cloud. ENI: Elastic Network Interface (ENI) Alibaba Cloud. NLB: instance Network Load Balancer (NLB) Alibaba Cloud. Catatan Jika Anda mengatur tipe endpoint menjadi ECS, ENI, SLB, NLB, atau IpTarget, dan service-linked role tidak ada, sistem secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaVpcEndpoint. Jika Anda mengatur tipe endpoint menjadi ALB, dan service-linked role tidak ada, sistem secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaAlb. Jika Anda mengatur tipe endpoint menjadi OSS, dan service-linked role tidak ada, sistem secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaOss. Catatan Untuk informasi lebih lanjut, lihat .	Ip
Weight	integer	Yes	Bobot (weight) endpoint. Nilai yang valid: 0 hingga 255. Catatan Jika Anda mengatur bobot endpoint menjadi 0, GA berhenti mendistribusikan lalu lintas ke endpoint tersebut. Tangani hal ini dengan hati-hati.	20
Endpoint	string	Yes	Alamat IP, nama domain, atau ID instance dari endpoint, berdasarkan nilai Type.	47.0.XX.XX
SubAddress	string	No	Alamat IP privat dari ENI. Catatan Parameter ini hanya tersedia ketika tipe endpoint adalah ENI. Anda dapat menentukan parameter ini. Jika Anda tidak menentukan parameter ini, alamat IP privat utama dari ENI akan digunakan.	172.168.XX.XX
EnableClientIPPreservation	boolean	No	Menentukan apakah akan mempertahankan alamat IP klien. Nilai yang valid: true: mempertahankan alamat IP klien. false (default): tidak mempertahankan alamat IP klien. Catatan Secara default, pelestarian alamat IP klien dinonaktifkan untuk grup endpoint dari listener TCP dan UDP. Anda dapat mengaktifkannya berdasarkan kebutuhan bisnis Anda. Pelestarian alamat IP klien diaktifkan secara default untuk grup endpoint dari listener HTTP dan HTTPS. Alamat IP klien diambil dari field header X-Forwarded-For. Anda tidak dapat menonaktifkan fitur ini. EnableClientIPPreservation dan EnableProxyProtocol tidak dapat diatur menjadi true secara bersamaan. Untuk informasi lebih lanjut, lihat .
EnableProxyProtocol	boolean	No	Menentukan apakah akan menggunakan Proxy Protocol untuk mempertahankan alamat IP klien. Nilai yang valid: true: menggunakan Proxy Protocol. false (default): tidak menggunakan Proxy Protocol. Catatan Parameter ini hanya tersedia untuk grup endpoint dari listener TCP. EnableClientIPPreservation dan EnableProxyProtocol tidak dapat diatur menjadi true secara bersamaan. Untuk informasi lebih lanjut, lihat .
VpcId	string	No	ID dari virtual private cloud (VPC). Anda dapat menentukan paling banyak satu ID VPC untuk grup endpoint yang terhubung dengan listener yang menggunakan smart routing. Catatan Parameter ini wajib diisi dan hanya berlaku ketika tipe endpoint adalah IpTarget.	vpc-uf66oesmrqge1t2gs****
VSwitchIds	array	No	Daftar vSwitch dalam VPC.
	string	No	The ID of the vSwitch. You can specify at most two vSwitch IDs for an endpoint group that is associated with a listener that uses smart routing. Catatan This parameter is required and takes effect only when the endpoint type is IpTarget. The vSwitch must belong to the VPC specified by the VpcId parameter.	vsw-uf6r0due94mypz1i9****
Provider	string	No		BAILIAN
ApiKeys	array	No
	string	No		sk-*******
EndpointRequestProtocol	string	No	Protokol layanan backend. Nilai yang valid: HTTP: HTTP HTTPS: HTTPS Catatan Anda hanya dapat mengatur parameter ini ketika Anda membuat grup endpoint untuk listener HTTP atau HTTPS. Untuk listener HTTP, protokol layanan backend harus HTTP.	HTTP
EndpointProtocolVersion	string	No	Versi protokol layanan backend untuk endpoint dalam listener yang menggunakan smart routing. Nilai yang valid: HTTP1.1 (default): HTTP/1.1 HTTP2: HTTP/2 Catatan Parameter ini hanya tersedia ketika Anda mengatur EndpointRequestProtocol menjadi HTTPS.	HTTP1.1
PortOverrides	array<object>	No	Pemetaan port.
	object	No	Pemetaan port.
ListenerPort	integer	No	Port listener. Nilai yang valid: 1 hingga 65499. Catatan Untuk listener TCP, grup endpoint virtual tidak mendukung pemetaan port. Jika grup endpoint virtual sudah ada di bawah listener, Anda tidak dapat mengonfigurasi pemetaan port untuk grup endpoint default. Jika pemetaan port sudah dikonfigurasi untuk grup endpoint default, Anda tidak dapat menambahkan grup endpoint virtual. Setelah Anda mengonfigurasi pemetaan port, batasan berikut berlaku pada modifikasi listener berikutnya: Anda tidak dapat mengubah protokol listener, kecuali untuk mengubahnya antara HTTP dan HTTPS. Port listener: Rentang port listener yang dimodifikasi harus mencakup semua port listener yang saat ini dipetakan. Misalnya, jika rentang port listener adalah 80-82 dan port tersebut dipetakan ke port endpoint 100-102, Anda tidak dapat mengubah rentang port listener menjadi 80-81.	443
EndpointPort	integer	No	Port endpoint. Nilai yang valid: 1 hingga 65499.	80
EnableClientIPPreservationToa	boolean	No	Menentukan apakah akan menggunakan modul TCP Option Address (TOA) untuk mempertahankan alamat IP klien. Nilai yang valid: true: ya. false: tidak.	false
EnableClientIPPreservationProxyProtocol	boolean	No	Menentukan apakah akan menggunakan Proxy Protocol untuk mempertahankan alamat IP klien. Nilai yang valid: true: ya. false: tidak.	false
EndpointGroupId	string	Yes	ID grup endpoint.	ep-bp1d2utp8qqe2a44t****
HealthCheckHost	string	No
EndpointIpVersion	string	No
ListenerId	string	Yes	ID listener.	lsr-bp1bpn0kn908w4nbw****

Elemen respons

Element	Type	Description	Example
	object	Respons.
RequestId	string	ID permintaan.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	ID dari grup endpoint.
	string	ID grup endpoint.	epg-bp1dmlohjjz4kqaun****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "EndpointGroupIds": [
    "epg-bp1dmlohjjz4kqaun****"
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
400	NotExist.EndPointGroup	The endpoint group does not exist.
400	StateError.EndPointGroup	The specified state of endpoint group is invalid.
400	NotExist.Listener	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.
400	NotExist.Accelerator	The accelerated instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.
400	NotExist.ListenerPort	listener port %s is not exist

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.