Batch Create GA Endpoint Groups via API at Scale - Global Accelerator - Alibaba Cloud - Global Accelerator

Membuat endpoint group secara batch.

Deskripsi operasi

Membuat endpoint group secara batch. Endpoint group default dan virtual tidak dapat dibuat dalam satu pemanggilan yang sama.
API ini tidak mendukung pembuatan endpoint group virtual untuk listener Layer-4. Untuk membuat endpoint group virtual bagi listener Layer-4, panggil CreateEndpointGroup.
CreateEndpointGroups adalah API asinkron. API ini mengembalikan ID permintaan dan membuat endpoint group di latar belakang. Anda dapat memanggil DescribeEndpointGroup atau ListEndpointGroups untuk menanyakan status sebuah endpoint group:
- Jika sebuah endpoint group dalam status init, endpoint group tersebut sedang diinisialisasi. Anda hanya dapat menanyakan endpoint group dalam status ini.
- Pembuatan batch selesai ketika semua endpoint group dalam status active.
Anda tidak dapat melakukan pemanggilan bersamaan ke CreateEndpointGroups untuk instance 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:CreateEndpointGroups

create

*EndpointGroup

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

*Accelerator

acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

ga:AcceleratorMainland

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region tempat accelerator di-deploy. Atur nilainya ke cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat membuat token di sisi klien. Pastikan token tersebut unik di setiap permintaan. Nilai `ClientToken` hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan sebagai ClientToken. RequestId bersifat unik untuk setiap permintaan API.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: melakukan dry run tetapi tidak membuat resource. Sistem memeriksa parameter yang diperlukan, format permintaan, dan batas layanan. Jika permintaan gagal dry run, sistem mengembalikan pesan error. Jika permintaan lulus dry run, sistem mengembalikan kode status HTTP 2xx. false (default): mengirimkan permintaan normal dan membuat resource jika permintaan lulus.	true
AcceleratorId	string	Yes	ID dari accelerator.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Yes	ID dari listener. Catatan Jika protokol listener adalah HTTP atau HTTPS, Anda hanya dapat membuat satu endpoint group dalam setiap pemanggilan CreateEndpointGroups.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	Yes	Konfigurasi endpoint group. Anda dapat mengonfigurasi hingga 10 endpoint group.
	array<object>	No	Konfigurasi sebuah endpoint group.
EndpointGroupName	string	No	Nama endpoint group. Nama harus terdiri dari 1 sampai 128 karakter, diawali dengan huruf atau karakter Tionghoa, serta dapat mengandung angka, titik (.), garis bawah (_), dan tanda hubung (-).	group1
EndpointGroupDescription	string	No	Deskripsi endpoint group. Deskripsi dapat memiliki panjang hingga 200 karakter dan tidak boleh diawali dengan `http://` atau `https://`.	EndpointGroup
EndpointGroupRegion	string	Yes	ID region tempat endpoint group di-deploy. Anda dapat memasukkan hingga 10 ID region endpoint group.	cn-hongkong
TrafficPercentage	integer	No	Persentase distribusi trafik untuk endpoint group. Jika sebuah intelligent routing listener terkait dengan beberapa endpoint group, parameter ini menentukan persentase trafik yang dirutekan ke endpoint group ini. Nilai yang valid: 1 hingga 100. Nilai default: 100. Anda dapat memasukkan nilai traffic dial untuk hingga 10 endpoint group.	100
HealthCheckEnabled	boolean	No	Menentukan apakah akan mengaktifkan health check untuk endpoint group. Nilai yang valid: true: mengaktifkan health check. false (default): menonaktifkan health check. Anda dapat mengaktifkan health check untuk hingga 10 endpoint group.	false
HealthCheckIntervalSeconds	integer	No	Interval antara health check, dalam detik. Anda dapat memasukkan hingga 10 interval health check.	5
HealthCheckPath	string	No	Path yang digunakan untuk health check. Anda dapat memasukkan hingga 10 path health check.	/healthcheck
HealthCheckPort	integer	No	Port yang digunakan untuk health check. Nilai yang valid: 1 hingga 65535. Anda dapat memasukkan hingga 10 port untuk health check.	443
HealthCheckProtocol	string	No	Protokol yang digunakan untuk health check. Nilai yang valid: tcp atau TCP: protokol TCP. http atau HTTP: protokol HTTP. https atau HTTPS: protokol HTTPS. Anda dapat memasukkan hingga 10 protokol health check.	HTTPS
ThresholdCount	integer	No	Jumlah health check berturut-turut yang harus berhasil agar sebuah endpoint dianggap sehat, atau gagal agar dianggap tidak sehat. Nilai yang valid: 2 hingga 10. Nilai default: 3. Anda dapat memasukkan hingga 10 nilai untuk jumlah health check berturut-turut yang diperlukan untuk perubahan status kesehatan.	3
EndpointConfigurations	array<object>	No	Konfigurasi endpoint dalam endpoint group.
	object	No	Konfigurasi sebuah endpoint.
Type	string	No	Tipe endpoint dalam intelligent routing listener. Nilai yang valid: Domain: nama domain kustom. Ip: alamat IP kustom. IpTarget: alamat IP privat kustom. PublicIp: alamat IP publik Alibaba Cloud. ECS: instance ECS. SLB: instance SLB. ALB: instance ALB. OSS: bucket OSS. ENI: elastic network interface. NLB: instance NLB. Dalam sebuah endpoint group dari intelligent routing listener, Anda dapat menentukan hingga 100 endpoint. Catatan Jika tipe routing dari listener adalah Standard (intelligent routing), Anda harus mengonfigurasi endpoint group dan informasi endpoint untuk listener tersebut. Parameter ini wajib diisi. Jika Anda mengatur Type ke ECS, ENI, SLB, atau IpTarget dan service-linked role belum ada, sistem secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaVpcEndpoint. Jika Anda mengatur Type ke ALB dan service-linked role belum ada, sistem secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaAlb. Jika Anda mengatur Type ke OSS dan service-linked role belum ada, sistem secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaOss. Jika Anda mengatur Type ke NLB dan service-linked role belum ada, sistem secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaNlb. Catatan Untuk informasi selengkapnya, lihat service-linked roles.	Domain
Weight	integer	No	Bobot dari endpoint. Nilai yang valid: 0 hingga 255. Catatan Jika Anda mengatur bobot sebuah endpoint ke 0, Global Accelerator akan berhenti mendistribusikan trafik ke endpoint tersebut. Lanjutkan dengan hati-hati.	255
Endpoint	string	No	Alamat IP atau nama domain dari endpoint. Dalam sebuah endpoint group dari intelligent routing listener, Anda dapat memasukkan maksimum 100 alamat IP atau nama domain endpoint.	1.1.1.1
SubAddress	string	No	Alamat IP privat dari elastic network interface (ENI). Catatan Parameter ini hanya tersedia ketika tipe endpoint adalah ENI. Jika Anda tidak menentukan parameter ini, sistem menggunakan alamat IP privat utama dari ENI.	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 Untuk endpoint group dari listener UDP dan TCP, fitur preserve client IP dinonaktifkan secara default. Anda dapat mengaktifkan fitur ini berdasarkan kebutuhan bisnis Anda. Untuk endpoint group dari listener HTTP dan HTTPS, fitur preserve client IP diaktifkan secara default. Alamat IP klien dipertahankan dalam header X-Forwarded-For. Anda tidak dapat menonaktifkan fitur ini. `EnableClientIPPreservation` dan `EnableProxyProtocol` tidak dapat diatur ke `true` pada saat yang sama. Untuk informasi selengkapnya, lihat preserve client IP addresses.	false
EnableProxyProtocol	boolean	No	Menentukan apakah akan menggunakan Proxy Protocol untuk mempertahankan alamat IP klien. Nilai yang valid: true: menggunakan Proxy Protocol untuk mempertahankan alamat IP klien. false (default): tidak menggunakan Proxy Protocol untuk mempertahankan alamat IP klien. Catatan Parameter ini hanya tersedia untuk endpoint group yang terkait dengan listener TCP. `EnableClientIPPreservation` dan `EnableProxyProtocol` tidak dapat diatur ke `true` pada saat yang sama. Untuk informasi selengkapnya, lihat preserve client IP addresses.	false
VpcId	string	No	ID dari VPC. Dalam sebuah endpoint group dari intelligent routing listener, Anda hanya dapat menentukan satu ID VPC. Catatan Parameter ini hanya wajib diisi ketika Anda mengatur Type ke IpTarget.	vpc-2zekzii824szm3hps****
VSwitchIds	array	No	Daftar ID VSwitch.
	string	No	The ID of the vSwitch. You can specify up to two vSwitch IDs for an endpoint group. Catatan This parameter is required and takes effect only when the endpoint type is set to IpTarget. The vSwitch must belong to the VPC specified by the VpcId parameter.	vsw-bp1b2qx7y2qqnbkan****
Provider	string	No		BAILIAN
ApiKeys	array	No
	string	No		sk-******
EndpointRequestProtocol	string	No	Protokol layanan backend. Nilai yang valid: HTTP HTTPS Catatan Anda hanya dapat mengatur parameter ini ketika Anda membuat endpoint group untuk listener HTTP atau HTTPS. Untuk listener HTTP, Anda hanya dapat mengatur parameter ini ke HTTP.	HTTPS
EndpointProtocolVersion	string	No	Versi protokol layanan backend. Nilai yang valid: HTTP1.1 (default): HTTP 1.1. HTTP2: HTTP 2. Catatan Anda hanya dapat mengatur parameter ini ketika `EndpointRequestProtocol` diatur ke HTTPS.	HTTP1.1
EndpointGroupType	string	No	Tipe endpoint group dalam intelligent routing listener. Nilai yang valid: default (default): endpoint group default. virtual: endpoint group virtual. Anda dapat memasukkan hingga 10 tipe endpoint group.	default
PortOverrides	array<object>	No	Pengaturan port override.
	object	No	Sebuah pengaturan port override.
ListenerPort	integer	No	Port listener. Nilai yang valid: 1 hingga 65499. Catatan Untuk listener TCP, Anda tidak dapat mengonfigurasi port override untuk endpoint group virtual. Jika sebuah endpoint group virtual sudah ada untuk listener tersebut, Anda tidak dapat mengonfigurasi port override untuk endpoint group default. Jika port override dikonfigurasi untuk endpoint group default, Anda tidak dapat menambahkan endpoint group virtual. Setelah Anda mengonfigurasi port override, Anda tidak dapat mengubah protokol listener, kecuali untuk beralih antara HTTP dan HTTPS. Ketika Anda mengubah rentang port listener, rentang baru harus mencakup semua port listener yang digunakan dalam port override. Misalnya, jika rentang port listener adalah 80-82 dan port override dikonfigurasi untuk memetakan port listener ke port endpoint 100-102, Anda tidak dapat mengubah rentang port listener menjadi 80-81.	80
EndpointPort	integer	No	Port endpoint yang digunakan untuk port override.	443
Tag	array<object>	No	Tag yang akan ditambahkan ke endpoint group. Anda dapat menentukan hingga 20 tag.
	object	No	Tag dari endpoint group.
Key	string	No	Key dari tag. Key tag tidak boleh berupa string kosong. Key tag dapat memiliki panjang hingga 64 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Key tag tidak boleh mengandung `http://` atau `https://`. Anda dapat memasukkan hingga 20 key tag.	tag-key
Value	string	No	Nilai dari tag. Nilai tag dapat berupa string kosong. Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Nilai tag tidak boleh mengandung `http://` atau `https://`. Anda dapat memasukkan hingga 20 nilai tag.	tag-value
SystemTag	array<object>	No	Parameter ini disediakan untuk penggunaan internal.
	object	No	Parameter ini disediakan untuk penggunaan internal.
Key	string	No	Parameter ini disediakan untuk penggunaan internal.	-
Value	string	No	Parameter ini disediakan untuk penggunaan internal.	-
Scope	string	No	Parameter ini disediakan untuk penggunaan internal.	-
HealthCheckHost	string	No	Nama domain tempat permintaan health check dikirim.	www.taobao.com
EndpointIpVersion	string	No	Versi IP dari layanan backend. Nilai yang valid: IPv4 (default): Global Accelerator hanya menggunakan alamat IPv4 untuk berkomunikasi dengan layanan backend. IPv6: Global Accelerator hanya menggunakan alamat IPv6 untuk berkomunikasi dengan layanan backend. ProtocolAffinity: Global Accelerator berkomunikasi dengan layanan backend menggunakan versi IP yang sama dengan permintaan klien.	IPv4

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
RequestId	string	ID permintaan.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	ID dari endpoint group.
	string	ID dari sebuah endpoint group.	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	Domain.NotFit	The domain is not fit the rule
400	Resource.QuotaFull	The resource quota is exceeded.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
400	NotSupportHealthCheck.Accelerator	Currently Accelerator does not support health check.
400	EndpointGroupExclusive.Listener	All endpoint group must under the same listener.
400	RegionConflict.EndpointGroup	Endpoint group under the same listener must have different region.
400	ListenerProtocolIllegal.EndpointGroup	Listener protocol is illegal, the https/http listener instance is only allowed to have one default endpoint group.
400	QuotaExceeded.EndpointGroup	The number of endpoint group exceeds the limit.
400	ParamExclusive.EndpointGroupType	All endpoint group type group must be consistent.
400	HealthCheckPath.Illegal	Health check path illegal.
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	NotExist.BusinessRegion	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.
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
400	MixedVpc.EndPoint	VPC Endpoint cannot be mixed with other types of Endpoints.
400	IllegalPublicIp.EndPoint	The public IP address configured for the endpoint is invalid. Only an Alibaba Cloud public IP address in the region of the endpoint can be configured.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.