Perbarui Pengaturan Grup Endpoint melalui API UpdateEndpointGroup - Global Accelerator - Alibaba Cloud - Global Accelerator

Memperbarui konfigurasi kelompok titik akhir.

Deskripsi operasi

The UpdateEndpointGroup API is an asynchronous API. After you call this API, the system returns a request ID and starts the update in the background; the configuration is not modified immediately. Call DescribeEndpointGroup to check the status of the endpoint group:
- If an endpoint group is in the updating status, its configuration is being modified, and you can only perform queries.
- If an endpoint group is in the active status, the update is complete.
The UpdateEndpointGroup API does not support concurrent updates to endpoint groups in the same Global Accelerator (GA) instance.

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 tempat instans GA di-deploy. Atur nilainya ke cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Token harus unik di antara permintaan dan hanya dapat berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId permintaan API sebagai ClientToken. RequestId bersifat unik untuk setiap permintaan API.	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, diawali dengan huruf atau karakter Tionghoa, dan dapat berisi angka, titik (.), garis bawah (_), dan tanda hubung (-).	group1
Description	string	No	Deskripsi kelompok titik akhir. Deskripsi dapat terdiri dari hingga 200 karakter dan tidak boleh diawali dengan `http://` atau `https://`.	EndpointGroup
EndpointGroupRegion	string	Yes	ID wilayah tempat kelompok titik akhir di-deploy.	cn-hangzhou
TrafficPercentage	integer	No	Bobot kelompok titik akhir ketika Pendengar dikaitkan dengan beberapa kelompok titik akhir dalam satu daftar.	20
HealthCheckIntervalSeconds	integer	No	Interval antara Pemeriksaan kesehatan, dalam detik. Nilai valid: 1 hingga 50.	3
HealthCheckPath	string	No	Path yang digunakan untuk Pemeriksaan kesehatan.	/healthcheck
HealthCheckPort	integer	No	Port yang digunakan untuk Pemeriksaan kesehatan. Nilai valid: 1 hingga 65535.	20
HealthCheckProtocol	string	No	Protokol yang digunakan untuk Pemeriksaan kesehatan. Nilai valid: tcp atau TCP http atau HTTP https atau HTTPS.	HTTPS
ThresholdCount	integer	No	Jumlah Pemeriksaan kesehatan berurutan yang berhasil atau gagal yang diperlukan sebelum status Pemeriksaan kesehatan suatu Titik akhir berubah. Nilai valid: 2 hingga 10.	3
EndpointConfigurations	array<object>	No	Konfigurasi Titik akhir.
	object	No	The configurations of the endpoints.
Type	string	Yes	The type of endpoint. Valid values: Domain: a custom domain name. Ip: a custom IP address. IpTarget: a custom private IP address. PublicIp: an Alibaba Cloud public IP address. ECS: an ECS instance. SLB: an SLB instance. ALB: an ALB instance. OSS: an OSS instance. ENI: an elastic network interface. NLB: an NLB instance. Catatan If the endpoint type is ECS, ENI, SLB, or IpTarget, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaVpcEndpoint. If the endpoint type is ALB, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaAlb. If the endpoint type is OSS, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaOss. If the endpoint type is NLB, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaNlb. Catatan For more information, see service-linked roles.	Ip
EnableClientIPPreservation	boolean	No	Specifies whether to preserve client source IP addresses. Valid values: true: Preserves client source IP addresses. false (default): Does not preserve client source IP addresses. Catatan For endpoint groups of TCP or UDP listeners, this feature is disabled by default but can be enabled if needed. For endpoint groups of HTTP or HTTPS listeners, client source IP addresses are preserved by default. The client IP addresses are retrieved from the X-Forwarded-For header. You cannot disable this feature. You cannot set both `EnableClientIPPreservation` and `EnableProxyProtocol` to `true`. For more information, see preserve client source IP addresses.	false
Weight	integer	Yes	The weight of the endpoint. Valid values: 0 to 255. Catatan If you set the weight of an endpoint to 0, Global Accelerator stops distributing traffic to the endpoint. Proceed with caution.	20
EnableProxyProtocol	boolean	No	Specifies whether to use the Proxy Protocol to preserve client source IP addresses. Valid values: true: Preserves client source IP addresses. false (default): Does not preserve client source IP addresses. Catatan You can configure this parameter only for endpoint groups of TCP listeners. You cannot set both `EnableClientIPPreservation` and `EnableProxyProtocol` to `true`. For more information, see preserve client source IP addresses.	false
Endpoint	string	Yes	Enter an IP address, a domain name, or an instance ID based on the value of the `Type` parameter.	120.XX.XX.21
SubAddress	string	No	The private IP address of the elastic network interface. Catatan If the endpoint type is ENI, you can specify this parameter. If you omit this parameter, the primary private IP address of the ENI is used.	172.168.XX.XX
VpcId	string	No	The ID of the VPC. You can specify at most one VPC ID for an endpoint group that is associated with an intelligent routing listener. Catatan This parameter is required only when the endpoint type is IpTarget.	vpc-2zen6t0u7xhm0k5iz****
VSwitchIds	array	No	A list of vSwitches in the VPC.
	string	No	The vSwitch ID. You can specify at most two vSwitch IDs for an endpoint group that is associated with an intelligent routing listener. Catatan This parameter is required only when the endpoint type is IpTarget. The vSwitch must belong to the VPC specified by the `VpcId` parameter.	vsw-2ze2dbtkxabpvpqxc****
Provider	string	No		BAILIAN
ApiKeys	array	No
	string	No		sk-******
EndpointRequestProtocol	string	No	Protokol yang digunakan oleh layanan backend. Daftar nilai valid: HTTP HTTPS Catatan Anda hanya dapat mengatur parameter ini untuk kelompok titik akhir yang dikaitkan dengan Pendengar HTTP atau HTTPS. Untuk Pendengar HTTP, protokol layanan backend harus HTTP.	HTTP
EndpointProtocolVersion	string	No	Versi protokol yang digunakan oleh layanan backend. Nilai valid: HTTP1.1 HTTP2 Catatan Anda hanya dapat mengatur parameter ini ketika `EndpointRequestProtocol` diatur ke HTTPS.	HTTP1.1
PortOverrides	array<object>	No	Konfigurasi Pemetaan port.
	object	No	The port override settings.
ListenerPort	integer	No	The listener port in the port override settings. Catatan For TCP listeners, virtual endpoint groups do not support port overrides. If a listener is already associated with a virtual endpoint group, you cannot configure port overrides for the default endpoint group. If the default endpoint group has port overrides configured, you cannot add a virtual endpoint group. After you configure port overrides, you can change the listener protocol only between HTTP and HTTPS. The updated listener port range must include all listener ports in the configured port overrides. For example, if the listener port range is 80-82 and port overrides are configured to map the ports to endpoint ports 100-102, you cannot update the listener port range to 80-81.	443
EndpointPort	integer	No	The endpoint port in the port override settings.	80
HealthCheckEnabled	boolean	No	Apakah akan mengaktifkan fitur Pemeriksaan kesehatan. Nilai 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
EndpointIpVersion	string	No	Protokol IP yang digunakan oleh GA untuk berkomunikasi dengan Titik akhir. Nilai valid: ● IPv4 (default): IPv4. ● IPv6: IPv6. ● ProtocolAffinity: protokol IP yang sama dengan permintaan Klien.	IPv4

Elemen respons

Element	Type	Description	Example
	object	The data returned in the response.
RequestId	string	The ID of the request.	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.