UpdateEndpointGroups - Global Accelerator

Memodifikasi kelompok titik akhir untuk sebuah listener secara batch.

Deskripsi operasi

Catatan Penggunaan

UpdateEndpointGroups bersifat asinkron. Setelah mengirim permintaan, sistem akan mengembalikan ID permintaan, sedangkan operasi tersebut terus berjalan di latar belakang. Anda dapat memanggil operasi DescribeEndpointGroup atau ListEndpointGroups untuk memeriksa status kelompok titik akhir.
- Jika kelompok titik akhir berada dalam status updating, konfigurasinya sedang dimodifikasi. Dalam status ini, hanya operasi kueri yang dapat dilakukan.
- Jika kelompok titik akhir berada dalam status active, konfigurasinya telah berhasil dimodifikasi.
Anda tidak dapat memanggil operasi UpdateEndpointGroups secara bersamaan untuk memodifikasi konfigurasi kelompok titik akhir yang termasuk dalam instans Global Accelerator 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 wilayah dari instans Global Accelerator. Tetapkan nilainya ke cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Buat nilai untuk parameter ini di sisi client 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 batasan layanan. Jika permintaan gagal dalam dry run, pesan error dikembalikan. Jika permintaan lolos dry run, kode status HTTP 2xx dikembalikan. false (default): mengirim permintaan. Jika permintaan lolos pemeriksaan, kode status HTTP 2xx dikembalikan dan operasi dilakukan.	true
EndpointGroupConfigurations	array<object>	Yes	Konfigurasi kelompok titik akhir.
	array<object>	No	Konfigurasi kelompok titik akhir.
EndpointGroupName	string	No	Nama kelompok titik akhir. Nama harus terdiri dari 1 hingga 128 karakter, dimulai dengan huruf atau karakter Tionghoa, serta dapat berisi huruf, angka, titik (.), garis bawah (_), dan tanda hubung (-).	group1
EndpointGroupDescription	string	No	Deskripsi kelompok titik akhir. Deskripsi dapat terdiri dari maksimal 200 karakter dan tidak boleh diawali dengan http:// atau https://.	group1
TrafficPercentage	integer	No	Rasio distribusi traffic. Jika sebuah listener dikaitkan dengan beberapa kelompok titik akhir, Anda dapat menentukan parameter ini untuk mendistribusikan traffic ke kelompok titik akhir tersebut. Nilai yang valid: 1 hingga 100.	20
HealthCheckEnabled	boolean	No	Menentukan apakah fitur pemeriksaan kesehatan diaktifkan. 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 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 sebuah titik akhir agar dianggap sehat, atau gagal agar dianggap tidak sehat. Nilai yang valid: 2 hingga 10.	3
EndpointConfigurations	array<object>	No	Konfigurasi titik akhir.
	object	Yes	Konfigurasi titik akhir.
Type	string	Yes	Jenis titik akhir. Domain: nama domain kustom. Ip: alamat IP kustom. IpTarget: alamat IP pribadi kustom. PublicIp: alamat IP publik Alibaba Cloud. ECS: instans Elastic Compute Service (ECS) Alibaba Cloud. SLB: instans Server Load Balancer (SLB) Alibaba Cloud. ALB: instans Application Load Balancer (ALB) Alibaba Cloud. OSS: bucket Object Storage Service (OSS) Alibaba Cloud. ENI: Elastic Network Interface (ENI) Alibaba Cloud. NLB: instans Network Load Balancer (NLB) Alibaba Cloud. Catatan Jika Anda menetapkan jenis titik akhir ke ECS, ENI, SLB, NLB, atau IpTarget, dan peran terkait layanan belum ada, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaVpcEndpoint. Jika Anda menetapkan jenis titik akhir ke ALB, dan peran terkait layanan belum ada, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaAlb. Jika Anda menetapkan jenis titik akhir ke OSS, dan peran terkait layanan belum ada, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaOss. Catatan Untuk informasi selengkapnya, lihat Peran terkait layanan.	Ip
Weight	integer	Yes	Bobot titik akhir. Nilai yang valid: 0 hingga 255. Catatan Jika Anda menetapkan bobot titik akhir ke 0, Global Accelerator berhenti mendistribusikan traffic ke titik akhir tersebut. Harap berhati-hati saat melakukannya.	20
Endpoint	string	Yes	Alamat IP, nama domain, atau ID instans titik akhir, tergantung pada nilai Type.	47.0.XX.XX
SubAddress	string	No	Alamat IP pribadi ENI. Catatan Parameter ini hanya tersedia ketika jenis titik akhir adalah ENI. Anda dapat menentukan parameter ini. Jika tidak ditentukan, alamat IP pribadi utama ENI akan digunakan.	172.168.XX.XX
EnableClientIPPreservation	boolean	No	Menentukan apakah alamat IP client dipertahankan. Nilai yang valid: true: mempertahankan alamat IP client. false (default): tidak mempertahankan alamat IP client. Catatan Secara default, pelestarian alamat IP client dinonaktifkan untuk kelompok titik akhir listener TCP dan UDP. Anda dapat mengaktifkannya sesuai kebutuhan bisnis. Pelestarian alamat IP client diaktifkan secara default untuk kelompok titik akhir listener HTTP dan HTTPS. Alamat IP client diambil dari bidang header X-Forwarded-For. Anda tidak dapat menonaktifkan fitur ini. EnableClientIPPreservation dan EnableProxyProtocol tidak dapat diatur ke true secara bersamaan. Untuk informasi selengkapnya, lihat Pertahankan alamat IP client.
EnableProxyProtocol	boolean	No	Menentukan apakah akan menggunakan Proxy Protocol untuk mempertahankan alamat IP client. Nilai yang valid: true: menggunakan Proxy Protocol. false (default): tidak menggunakan Proxy Protocol. Catatan Parameter ini hanya tersedia untuk kelompok titik akhir listener TCP. EnableClientIPPreservation dan EnableProxyProtocol tidak dapat diatur ke true secara bersamaan. Untuk informasi selengkapnya, lihat Pertahankan alamat IP client.
VpcId	string	No	ID virtual private cloud (VPC). Anda dapat menentukan maksimal satu ID VPC untuk kelompok titik akhir yang dikaitkan dengan listener yang menggunakan perutean pintar. Catatan Parameter ini wajib dan hanya berlaku ketika jenis titik akhir adalah IpTarget.	vpc-uf66oesmrqge1t2gs****
VSwitchIds	array	No	Daftar vSwitch di dalam VPC.
	string	No	ID vSwitch. Anda dapat menentukan maksimal dua ID vSwitch untuk kelompok titik akhir yang dikaitkan dengan listener yang menggunakan perutean pintar. Catatan Parameter ini wajib dan hanya berlaku ketika jenis titik akhir adalah IpTarget. vSwitch harus termasuk dalam VPC yang ditentukan oleh parameter VpcId.	vsw-uf6r0due94mypz1i9****
EndpointRequestProtocol	string	No	Protokol layanan backend. Nilai yang valid: HTTP: HTTP HTTPS: HTTPS Catatan Anda hanya dapat mengatur parameter ini saat membuat kelompok titik akhir untuk listener HTTP atau HTTPS. Untuk listener HTTP, protokol layanan backend harus HTTP.	HTTP
EndpointProtocolVersion	string	No	Versi protokol layanan backend untuk titik akhir dalam listener yang menggunakan perutean pintar. Nilai yang valid: HTTP1.1 (default): HTTP/1.1 HTTP2: HTTP/2 Catatan Parameter ini hanya tersedia ketika Anda menetapkan EndpointRequestProtocol ke 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, kelompok titik akhir virtual tidak mendukung pemetaan port. Jika kelompok titik akhir virtual sudah ada di bawah listener tersebut, Anda tidak dapat mengonfigurasi pemetaan port untuk kelompok titik akhir default. Jika pemetaan port sudah dikonfigurasi untuk kelompok titik akhir default, Anda tidak dapat menambahkan kelompok titik akhir virtual. Setelah Anda mengonfigurasi pemetaan port, batasan berikut berlaku untuk modifikasi listener selanjutnya: Anda tidak dapat mengubah protokol listener, kecuali mengubahnya antara HTTP dan HTTPS. Port listener: Range port listener yang dimodifikasi harus mencakup semua port listener yang saat ini dipetakan. Misalnya, jika range port listener adalah 80–82 dan port-port tersebut dipetakan ke port titik akhir 100–102, Anda tidak dapat mengubah range port listener menjadi 80–81.	443
EndpointPort	integer	No	Port titik akhir. Nilai yang valid: 1 hingga 65499.	80
EnableClientIPPreservationToa	boolean	No	Menentukan apakah akan menggunakan modul TCP Option Address (TOA) untuk mempertahankan alamat IP client. Nilai yang valid: true: ya. false: tidak.	false
EnableClientIPPreservationProxyProtocol	boolean	No	Menentukan apakah akan menggunakan Proxy Protocol untuk mempertahankan alamat IP client. Nilai yang valid: true: ya. false: tidak.	false
EndpointGroupId	string	Yes	ID kelompok titik akhir.	ep-bp1d2utp8qqe2a44t****
HealthCheckHost	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 kelompok titik akhir.
	string	ID kelompok titik akhir.	epg-bp1dmlohjjz4kqaun****

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.	The current account does not have the permissions to enable health checks.
400	NotExist.EndPointGroup	The endpoint group does not exist.	The endpoint group does not exist.
400	StateError.EndPointGroup	The specified state of endpoint group is invalid.	The endpoint group is in an invalid state.
400	NotExist.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The listener is unstable.
400	NotExist.Accelerator	The accelerated instance does not exist.	The GA instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The status of the GA instance is invalid.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	The user does not have permissions to create service linked roles. Contact the Alibaba Cloud account owner or the permission administrator to grant the current user AliyunGlobalAccelerationFullAccess or create custom permission policies for service linked role. The following content describes the detailed information about custom permission policies: ServiceName: vpcendpoint.ga.aliyuncs.com. Service linked role name: AliyunServiceRoleForGaVpc. Endpoint Permission: ram:CreateServiceLinkedRole.
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.	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.