UpdateEndpointGroup - Global Accelerator

Memodifikasi konfigurasi kelompok titik akhir.

Deskripsi operasi

UpdateEndpointGroup adalah operasi asinkron. Setelah mengirim permintaan, sistem akan mengembalikan ID permintaan, sedangkan operasi tersebut terus berjalan di latar belakang. Anda dapat memanggil DescribeEndpointGroup 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 UpdateEndpointGroup secara bersamaan untuk memodifikasi konfigurasi kelompok titik akhir 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:UpdateEndpointGroup

update

*EndpointGroup

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah instans Global Accelerator. Tetapkan nilainya ke cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Buat nilai parameter dari client Anda untuk memastikan bahwa 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
EndpointGroupId	string	Yes	ID kelompok titik akhir.	epg-bp1dmlohjjz4kqaun****
Name	string	No	Nama kelompok titik akhir. Nama harus terdiri dari 1 hingga 128 karakter, dimulai dengan huruf atau karakter Tionghoa, dan dapat berisi angka, titik (.), garis bawah (_), serta tanda hubung (-).	group1
Description	string	No	Deskripsi kelompok titik akhir. Deskripsi dapat memiliki panjang maksimal 200 karakter dan tidak boleh dimulai dengan `http://` atau `https://`.	EndpointGroup
EndpointGroupRegion	string	Yes	ID wilayah tempat kelompok titik akhir ditempatkan.	cn-hangzhou
TrafficPercentage	integer	No	Bobot kelompok titik akhir. Ketika sebuah listener dikaitkan dengan beberapa kelompok titik akhir, traffic didistribusikan ke kelompok titik akhir berdasarkan bobotnya.	20
HealthCheckIntervalSeconds	integer	No	Interval antara dua pemeriksaan kesehatan berturut-turut. Satuan: detik. Nilai yang valid: 1 hingga 50.	3
HealthCheckPath	string	No	Jalur untuk 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. Nilai yang valid: tcp atau TCP: TCP http atau HTTP: HTTP https atau HTTPS: HTTPS	HTTPS
ThresholdCount	integer	No	Jumlah kegagalan pemeriksaan kesehatan berturut-turut yang harus terjadi sebelum titik akhir yang sehat dianggap tidak sehat, atau jumlah keberhasilan pemeriksaan kesehatan berturut-turut yang harus terjadi sebelum titik akhir yang tidak sehat dianggap sehat. Nilai yang valid: 2 hingga 10.	3
EndpointConfigurations	array<object>	No	Konfigurasi titik akhir.
	object	No	Konfigurasi titik akhir.
Type	string	Yes	Jenis titik akhir. Nilai yang valid: 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: Instance OSS Alibaba Cloud. ENI: ENI Alibaba Cloud. NLB: Instance NLB Alibaba Cloud. Catatan Jika Anda menetapkan jenis titik akhir ke ECS, ENI, SLB, ALB, NLB, atau IpTarget, dan peran terkait layanan AliyunServiceRoleForGaVpcEndpoint tidak ada, sistem akan secara otomatis membuat peran terkait layanan tersebut. Jika Anda menetapkan jenis titik akhir ke ALB, dan peran terkait layanan AliyunServiceRoleForGaAlb tidak ada, sistem akan secara otomatis membuat peran terkait layanan tersebut. Jika Anda menetapkan jenis titik akhir ke OSS, dan peran terkait layanan AliyunServiceRoleForGaOss tidak ada, sistem akan secara otomatis membuat peran terkait layanan tersebut. Jika Anda menetapkan jenis titik akhir ke NLB, dan peran terkait layanan AliyunServiceRoleForGaNlb tidak ada, sistem akan secara otomatis membuat peran terkait layanan tersebut. Catatan Untuk informasi selengkapnya, lihat Peran terkait layanan.	Ip
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, fitur pemertahanan alamat IP client dinonaktifkan untuk kelompok titik akhir listener UDP dan TCP. Anda dapat mengaktifkannya sesuai kebutuhan. Secara default, fitur pemertahanan alamat IP client diaktifkan untuk kelompok titik akhir listener HTTP dan HTTPS. Alamat IP client diperoleh dari 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.	false
Weight	integer	Yes	Bobot titik akhir. Nilai yang valid: 0 hingga 255. Catatan Jika Anda menetapkan bobot titik akhir ke 0, Global Accelerator akan berhenti mendistribusikan traffic ke titik akhir tersebut. Harap berhati-hati saat melakukannya.	20
EnableProxyProtocol	boolean	No	Menentukan apakah protokol proxy digunakan untuk mempertahankan alamat IP client. Nilai yang valid: true: menggunakan protokol proxy. false (default): tidak menggunakan protokol proxy. 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.	false
Endpoint	string	Yes	Alamat IP, nama domain, atau ID instans titik akhir, tergantung pada nilai Type.	120.XX.XX.21
SubAddress	string	No	Alamat IP pribadi ENI. Catatan Parameter ini hanya tersedia ketika jenis titik akhir adalah ENI. Jika Anda tidak menentukan parameter ini, alamat IP pribadi utama ENI akan digunakan.	172.168.XX.XX
VpcId	string	No	ID 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-2zen6t0u7xhm0k5iz****
VSwitchIds	array	No	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-2ze2dbtkxabpvpqxc****
EndpointRequestProtocol	string	No	Protokol layanan backend. Nilai yang valid: HTTP HTTPS Catatan Parameter ini hanya tersedia ketika Anda 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. Nilai yang valid: HTTP1.1 HTTP2 Catatan Parameter ini hanya tersedia ketika EndpointRequestProtocol diatur ke HTTPS.	HTTP1.1
PortOverrides	array<object>	No	Pemetaan port.
	object	No	Pemetaan port.
ListenerPort	integer	No	Port listener yang dipetakan ke port titik akhir. Catatan Untuk listener TCP, kelompok titik akhir virtual tidak mendukung pemetaan port. Jika listener sudah dikaitkan dengan kelompok titik akhir virtual, Anda tidak dapat mengonfigurasi pemetaan port untuk kelompok titik akhir default. Jika Anda telah mengonfigurasi pemetaan port untuk kelompok titik akhir default, Anda tidak dapat menambahkan kelompok titik akhir virtual ke listener tersebut. Setelah Anda mengonfigurasi pemetaan port, batasan berikut berlaku saat Anda memodifikasi listener: Anda tidak dapat mengubah protokol listener, kecuali beralih antara HTTP dan HTTPS. Port listener: Rentang port listener yang dimodifikasi harus mencakup semua port listener yang dikonfigurasi dalam pemetaan port yang ada. Misalnya, jika rentang port listener saat ini adalah 80–82 dan Anda telah memetakan port listener 80, 81, dan 82 ke port titik akhir 100, 101, dan 102, Anda tidak dapat mengubah rentang port listener menjadi 80–81.	443
EndpointPort	integer	No	Port titik akhir yang dipetakan dari port listener.	80
HealthCheckEnabled	boolean	No	Menentukan apakah fitur pemeriksaan kesehatan diaktifkan. Nilai yang valid: true: mengaktifkan fitur pemeriksaan kesehatan. false (default): menonaktifkan fitur pemeriksaan kesehatan.	true
HealthCheckHost	string	No	Nama domain yang digunakan untuk pemeriksaan kesehatan.	www.taobao.com

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
RequestId	string	ID permintaan.	6FEA0CF3-D3B9-43E5-A304-D217037876A8

Contoh

Respons sukses

JSONformat

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

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.