CreateEndpointGroup - Global Accelerator

Panggil operasi CreateEndpointGroup untuk membuat kelompok titik akhir.

Deskripsi operasi

Kelompok titik akhir default diperlukan saat Anda membuat kelompok titik akhir virtual untuk listener Lapisan 4.
CreateEndpointGroup adalah operasi asinkron. Setelah permintaan dikirim, sistem mengembalikan ID kelompok titik akhir, tetapi pembuatan kelompok tersebut masih berlangsung di latar belakang. Anda dapat memanggil operasi DescribeEndpointGroup untuk memeriksa status kelompok titik akhir.
- Jika kelompok titik akhir berada dalam status init, artinya proses pembuatan sedang berjalan. Dalam status ini, hanya operasi kueri yang dapat dilakukan.
- Jika kelompok titik akhir berada dalam status active, artinya pembuatan telah berhasil.
Operasi CreateEndpointGroup tidak mendukung pemanggilan konkuren untuk membuat kelompok titik akhir pada 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:CreateEndpointGroup

create

*EndpointGroup

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

*Listener

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

*Accelerator

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

ga:AcceleratorMainland

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 klien yang digunakan untuk memastikan idempotensi permintaan. Buat nilai untuk parameter ini dari klien 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
AcceleratorId	string	Yes	ID instans Global Accelerator.	ga-bp1odcab8tmno0hdq****
Name	string	No	Nama kelompok titik akhir. Nama harus terdiri dari 1 hingga 128 karakter, dimulai dengan huruf, 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 Anda ingin membuat kelompok titik akhir.	cn-hangzhou
ListenerId	string	Yes	ID listener.	lsr-bp1bpn0kn908w4nbw****
TrafficPercentage	integer	No	Rasio trafik untuk kelompok titik akhir ketika listener dikaitkan dengan beberapa kelompok titik akhir. Nilai yang valid: 1 hingga 100.	20
HealthCheckIntervalSeconds	integer	No	Interval antara dua pemeriksaan kesehatan berturut-turut. Satuan: detik.	3
HealthCheckPath	string	No	Jalur untuk pemeriksaan kesehatan.	/healthcheck
HealthCheckPort	integer	No	Port yang digunakan untuk pemeriksaan kesehatan.	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	tcp
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. Nilai default: 3.	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: 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 jenis titik akhir diatur ke ECS, ENI, SLB, ALB, NLB, atau IpTarget, dan peran terkait layanan belum ada, sistem akan secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaVpcEndpoint. Jika jenis titik akhir diatur ke ALB, dan peran terkait layanan belum ada, sistem akan secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaAlb. Jika jenis titik akhir diatur ke OSS, dan peran terkait layanan belum ada, sistem akan secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaOss. Jika jenis titik akhir diatur ke NLB, dan peran terkait layanan belum ada, sistem akan secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaNlb. Catatan Untuk informasi selengkapnya, lihat Peran terkait layanan.	Ip
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 Secara default, fitur pelestarian alamat IP klien dinonaktifkan untuk kelompok titik akhir listener UDP dan TCP. Anda dapat mengaktifkannya sesuai kebutuhan bisnis. Fitur pelestarian alamat IP klien diaktifkan secara default untuk kelompok titik akhir listener HTTP dan HTTPS. Alamat IP klien diperoleh dari Header X-Forwarded-For. Fitur ini tidak dapat dinonaktifkan. EnableClientIPPreservation dan EnableProxyProtocol tidak dapat diatur ke true secara bersamaan. Untuk informasi selengkapnya, lihat Pertahankan alamat IP klien.	false
Weight	integer	Yes	Bobot titik akhir. Nilai yang valid: 0 hingga 255. Catatan Jika Anda mengatur bobot titik akhir ke 0, Global Accelerator akan berhenti mendistribusikan traffic ke titik akhir tersebut. Lakukan hal ini dengan hati-hati.	20
EnableProxyProtocol	boolean	No	Menentukan apakah protokol proxy digunakan untuk melestarikan alamat IP klien. 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 klien.	false
Endpoint	string	Yes	Alamat IP, nama domain, atau ID instans titik akhir, tergantung pada nilai Type.	120.1.XX.XX
SubAddress	string	No	Alamat IP pribadi ENI. Catatan Parameter ini hanya tersedia ketika jenis titik akhir diatur ke ENI. Jika Anda tidak menentukan parameter ini, alamat IP pribadi utama ENI akan digunakan.	172.168.X.X
VpcId	string	No	ID VPC. Anda dapat menentukan maksimal satu ID VPC untuk kelompok titik akhir listener perutean pintar. Catatan Parameter ini wajib dan hanya berlaku ketika jenis titik akhir diatur ke IpTarget.	vpc-bp1quce3451z5b2hv****
VSwitchIds	array	No	Daftar vSwitch di dalam VPC.
	string	No	ID vSwitch. Anda dapat menentukan maksimal dua ID vSwitch untuk kelompok titik akhir listener perutean pintar. Catatan Parameter ini wajib dan hanya berlaku ketika jenis titik akhir diatur ke IpTarget. vSwitch harus termasuk dalam VPC yang ditentukan oleh parameter VpcId.	vsw-bp12mho4ze51ezagm****
EndpointRequestProtocol	string	No	Protokol layanan backend. Nilai yang valid: HTTP (default) 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. Nilai yang valid: HTTP1.1 (default): HTTP/1.1 HTTP2: HTTP/2 Catatan Anda hanya dapat mengatur parameter ini ketika protokol layanan backend diatur ke HTTPS.	HTTP1.1
EndpointGroupType	string	No	Jenis kelompok titik akhir. Nilai yang valid: default (default): kelompok titik akhir default. virtual: kelompok titik akhir virtual. Catatan Saat membuat kelompok titik akhir virtual untuk listener Lapisan 4, pastikan kelompok titik akhir default telah dibuat.	default
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 kelompok titik akhir virtual sudah ada untuk listener, Anda tidak dapat mengonfigurasi pemetaan port untuk kelompok titik akhir default. Jika pemetaan port telah dikonfigurasi untuk kelompok titik akhir default, Anda tidak dapat menambahkan kelompok titik akhir virtual. Setelah mengonfigurasi pemetaan port, Anda tidak dapat mengubah protokol listener, kecuali mengganti antara HTTP dan HTTPS. Jika Anda mengubah range port listener, range baru harus mencakup semua port listener yang saat ini dipetakan. Misalnya, jika range port listener saat ini adalah 80–82 dan Anda memiliki pemetaan untuk port 80, 81, dan 82, Anda tidak dapat mengubah range 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: menonaktifkan fitur pemeriksaan kesehatan.	true
Tag	array<object>	No	Tag kelompok titik akhir.
	object	No	Tag kelompok titik akhir.
Key	string	No	Kunci tag kelompok titik akhir. 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 berisi `http://` atau `https://`. Anda dapat menentukan maksimal 20 kunci tag.	test-key
Value	string	No	Nilai tag kelompok titik akhir. Nilai tag boleh berupa string kosong. Nilai tag dapat memiliki panjang maksimal 128 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Tidak boleh berisi `http://` atau `https://`. Anda dapat menentukan maksimal 20 nilai tag.	test-value
DryRun	boolean	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: melakukan dry run. Sistem memeriksa parameter yang diperlukan, format permintaan, dan batas layanan. Jika permintaan gagal dalam dry run, pesan error dikembalikan. Jika permintaan lolos dry run, sistem mengembalikan kode status HTTP 2xx. false (default): mengirim permintaan. Jika permintaan lolos pemeriksaan, kode status HTTP 2xx dikembalikan dan kelompok titik akhir dibuat.	false
HealthCheckHost	string	No

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
EndpointGroupId	string	ID kelompok titik akhir.	epg-bp1dmlohjjz4kqaun****
RequestId	string	ID permintaan.	04F0F334-1335-436C-A1D7-6C044FE73368

Contoh

Respons sukses

JSONformat

{
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Domain.NotFit	The domain is not fit the rule	The domain name does not have an ICP number.
400	Resource.QuotaFull	The resource quota is exceeded.	The number of resources has reached the upper limit.
400	NotExist.ListenerPort	The listening port %s does not exist.	The listening port does not exist.
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.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	NotExist.BusinessRegion	The business region does not exist.	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	Exist.EndpointGroup	The endpoint group already exists.	The endpoint group already exists.
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.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.