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

Buat kelompok titik akhir.

Deskripsi operasi

Gunakan API ini untuk membuat kelompok titik akhir secara batch. Namun, Anda tidak dapat membuat kelompok titik akhir default dan virtual dalam satu panggilan.
API ini tidak mendukung pembuatan kelompok titik akhir virtual untuk listener Layer-4. Untuk membuat kelompok titik akhir virtual untuk listener Layer-4, panggil CreateEndpointGroup.
CreateEndpointGroups adalah API asinkron. API ini mengembalikan ID permintaan dan membuat kelompok titik akhir di latar belakang. Anda dapat memanggil DescribeEndpointGroup atau ListEndpointGroups untuk mengecek status kelompok titik akhir:
- Jika kelompok titik akhir berada dalam status init, artinya sedang dalam proses inisialisasi. Anda hanya dapat mengecek kelompok titik akhir dalam status ini.
- Pembuatan batch selesai ketika semua kelompok titik akhir berada dalam status active.
Anda tidak dapat melakukan panggilan konkuren ke CreateEndpointGroups untuk 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: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 wilayah tempat akselerator ditempatkan. Tetapkan nilainya ke cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menghasilkan token ini di sisi klien. Pastikan nilainya unik di antara permintaan yang berbeda. 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 menjalankan dry run. Nilai yang valid: true: menjalankan dry run tetapi tidak membuat resource. Sistem memeriksa parameter yang diperlukan, format permintaan, dan batas layanan. Jika permintaan gagal dalam dry run, sistem mengembalikan pesan error. Jika permintaan lolos dry run, sistem mengembalikan kode status HTTP 2xx. false (default): mengirim permintaan normal dan membuat resource jika permintaan lolos.	true
AcceleratorId	string	Yes	ID akselerator.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Yes	ID listener. Catatan Jika protokol listener adalah HTTP atau HTTPS, Anda hanya dapat membuat satu kelompok titik akhir dalam setiap panggilan CreateEndpointGroups.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	Yes	Konfigurasi kelompok titik akhir. Anda dapat mengonfigurasi hingga 10 kelompok titik akhir.
	array<object>	No	Konfigurasi satu 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 boleh mengandung angka, titik (.), garis bawah (_), dan tanda hubung (-).	group1
EndpointGroupDescription	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. Anda dapat memasukkan hingga 10 ID wilayah kelompok titik akhir.	cn-hongkong
TrafficPercentage	integer	No	Persentase distribusi traffic untuk kelompok titik akhir. Jika listener routing cerdas dikaitkan dengan beberapa kelompok titik akhir, parameter ini menentukan persentase traffic yang diarahkan ke kelompok titik akhir ini. Nilai yang valid: 1 hingga 100. Nilai default: 100. Anda dapat memasukkan nilai dial traffic untuk hingga 10 kelompok titik akhir.	100
HealthCheckEnabled	boolean	No	Menentukan apakah pemeriksaan kesehatan untuk kelompok titik akhir diaktifkan. Nilai yang valid: true: mengaktifkan pemeriksaan kesehatan. false (default): menonaktifkan pemeriksaan kesehatan. Anda dapat mengaktifkan pemeriksaan kesehatan untuk hingga 10 kelompok titik akhir.	false
HealthCheckIntervalSeconds	integer	No	Interval antar pemeriksaan kesehatan, dalam detik. Anda dapat memasukkan hingga 10 interval pemeriksaan kesehatan.	5
HealthCheckPath	string	No	Jalur yang digunakan untuk pemeriksaan kesehatan. Anda dapat memasukkan hingga 10 jalur pemeriksaan kesehatan.	/healthcheck
HealthCheckPort	integer	No	Port yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: 1 hingga 65535. Anda dapat memasukkan hingga 10 port untuk pemeriksaan kesehatan.	443
HealthCheckProtocol	string	No	Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: tcp atau TCP: protokol TCP. http atau HTTP: protokol HTTP. https atau HTTPS: protokol HTTPS. Anda dapat memasukkan hingga 10 protokol pemeriksaan kesehatan.	HTTPS
ThresholdCount	integer	No	Jumlah pemeriksaan kesehatan berturut-turut yang harus berhasil agar titik akhir 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 pemeriksaan kesehatan berturut-turut yang diperlukan untuk perubahan status kesehatan.	3
EndpointConfigurations	array<object>	No	Konfigurasi titik akhir dalam kelompok titik akhir.
	object	No	Konfigurasi satu titik akhir.
Type	string	No	Jenis titik akhir dalam listener routing cerdas. 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. SLB: Instance SLB. ALB: Instance ALB. OSS: Bucket OSS. ENI: antarmuka jaringan elastis. NLB: Instance NLB. Dalam kelompok titik akhir listener routing cerdas, Anda dapat menentukan hingga 100 titik akhir. Catatan Jika jenis routing listener adalah Standard (routing cerdas), Anda harus mengonfigurasi informasi kelompok titik akhir dan titik akhir untuk listener tersebut. Parameter ini wajib diisi. Jika Anda menetapkan Type ke ECS, ENI, SLB, atau IpTarget dan peran terkait layanan belum ada, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaVpcEndpoint. Jika Anda menetapkan Type ke ALB dan peran terkait layanan belum ada, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaAlb. Jika Anda menetapkan Type ke OSS dan peran terkait layanan belum ada, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaOss. Jika Anda menetapkan Type ke NLB dan peran terkait layanan belum ada, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaNlb. Catatan Untuk informasi selengkapnya, lihat peran terkait layanan.	Domain
Weight	integer	No	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. Lakukan dengan hati-hati.	255
Endpoint	string	No	Alamat IP atau nama domain titik akhir. Dalam kelompok titik akhir listener routing cerdas, Anda dapat memasukkan maksimal 100 alamat IP atau nama domain titik akhir.	1.1.1.1
SubAddress	string	No	Alamat IP pribadi dari antarmuka jaringan elastis (ENI). Catatan Parameter ini hanya tersedia ketika jenis titik akhir adalah ENI. Jika Anda tidak menentukan parameter ini, sistem menggunakan alamat IP pribadi utama dari ENI.	172.168.XX.XX
EnableClientIPPreservation	boolean	No	Menentukan apakah alamat IP klien dipertahankan. Nilai yang valid: true: mempertahankan alamat IP klien. false (default): tidak mempertahankan alamat IP klien. Catatan Untuk kelompok titik akhir listener UDP dan TCP, fitur pertahankan IP klien dinonaktifkan secara default. Anda dapat mengaktifkan fitur ini sesuai kebutuhan bisnis. Untuk kelompok titik akhir listener HTTP dan HTTPS, fitur pertahankan IP klien 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` secara bersamaan. Untuk informasi selengkapnya, lihat pertahankan alamat IP klien.	false
EnableProxyProtocol	boolean	No	Menentukan apakah 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 kelompok titik akhir yang dikaitkan dengan listener TCP. `EnableClientIPPreservation` dan `EnableProxyProtocol` tidak dapat diatur ke `true` secara bersamaan. Untuk informasi selengkapnya, lihat pertahankan alamat IP klien.	false
VpcId	string	No	ID VPC. Dalam kelompok titik akhir listener routing cerdas, Anda hanya dapat menentukan satu ID VPC. Catatan Parameter ini wajib diisi hanya ketika Anda menetapkan Type ke IpTarget.	vpc-2zekzii824szm3hps****
VSwitchIds	array	No	Daftar ID VSwitch.
	string	No	ID VSwitch. Dalam kelompok titik akhir listener routing cerdas, Anda dapat menentukan hingga dua ID VSwitch. Catatan Parameter ini wajib diisi dan hanya berlaku ketika jenis titik akhir adalah IpTarget. VSwitch harus berada dalam VPC yang ditentukan oleh parameter VpcId.	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 membuat kelompok titik akhir 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	Jenis kelompok titik akhir dalam listener routing cerdas. Nilai yang valid: default (default): kelompok titik akhir default. virtual: kelompok titik akhir virtual. Anda dapat memasukkan hingga 10 jenis kelompok titik akhir.	default
PortOverrides	array<object>	No	Pengaturan penggantian port.
	object	No	Pengaturan penggantian port.
ListenerPort	integer	No	Port listener. Nilai yang valid: 1 hingga 65499. Catatan Untuk listener TCP, Anda tidak dapat mengonfigurasi penggantian port untuk kelompok titik akhir virtual. Jika kelompok titik akhir virtual sudah ada untuk listener tersebut, Anda tidak dapat mengonfigurasi penggantian port untuk kelompok titik akhir default. Jika penggantian port telah dikonfigurasi untuk kelompok titik akhir default, Anda tidak dapat menambahkan kelompok titik akhir virtual. Setelah Anda mengonfigurasi penggantian port, Anda tidak dapat mengubah protokol listener, kecuali beralih antara HTTP dan HTTPS. Saat Anda mengubah rentang port listener, rentang baru harus mencakup semua port listener yang digunakan dalam penggantian port. Misalnya, jika rentang port listener adalah 80–82 dan penggantian port dikonfigurasi untuk memetakan port listener ke port titik akhir 100–102, Anda tidak dapat mengubah rentang port listener menjadi 80–81.	80
EndpointPort	integer	No	Port titik akhir yang digunakan untuk penggantian port.	443
Tag	array<object>	No	Tag yang akan ditambahkan ke kelompok titik akhir. Anda dapat menentukan hingga 20 tag.
	object	No	Tag kelompok titik akhir.
Key	string	No	Kunci tag. Kunci tag tidak boleh berupa string kosong. Kunci tag dapat memiliki panjang maksimal 64 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Tidak boleh mengandung `http://` atau `https://`. Anda dapat memasukkan hingga 20 kunci tag.	tag-key
Value	string	No	Nilai tag. Nilai tag boleh berupa string kosong. Nilai tag dapat memiliki panjang maksimal 128 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Tidak boleh mengandung `http://` atau `https://`. Anda dapat memasukkan hingga 20 nilai tag.	tag-value
SystemTag	array<object>	No	Parameter ini dicadangkan.
	object	No	Parameter ini dicadangkan.
Key	string	No	Parameter ini dicadangkan.	-
Value	string	No	Parameter ini dicadangkan.	-
Scope	string	No	Parameter ini dicadangkan.	-
HealthCheckHost	string	No	Nama domain tempat permintaan pemeriksaan kesehatan dikirim.	www.taobao.com
EndpointIpVersion	string	No	Versi IP 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 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
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.