Buat grup endpoint melalui API dengan otorisasi RAM - Global Accelerator - Alibaba Cloud - Global Accelerator

Buat kelompok titik akhir.

Deskripsi operasi

Sebelum membuat kelompok titik akhir virtual untuk listener Lapisan 4, Anda harus terlebih dahulu membuat kelompok titik akhir default.
CreateEndpointGroup adalah operasi asinkron. Setelah mengirim permintaan, sistem akan mengembalikan ID kelompok titik akhir dan mulai membuat kelompok tersebut di latar belakang. Anda dapat memanggil DescribeEndpointGroup untuk mengecek status kelompok titik akhir:
- Jika status kelompok titik akhir adalah init, berarti proses pembuatan sedang berlangsung. Dalam status ini, Anda hanya dapat melakukan operasi kueri.
- Jika status kelompok titik akhir adalah active, berarti pembuatan telah berhasil.
Anda tidak dapat melakukan panggilan bersamaan ke operasi CreateEndpointGroup 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: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 tempat instans Global Accelerator (GA) dideploy. Tetapkan nilainya ke cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menghasilkan token ini, tetapi harus memastikan bahwa token tersebut unik untuk setiap permintaan. Token hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan sebagai ClientToken. Setiap permintaan memiliki RequestId yang unik.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	ID instans GA.	ga-bp1odcab8tmno0hdq****
Name	string	No	Nama kelompok titik akhir. Nama harus terdiri dari 1 hingga 128 karakter, dimulai dengan huruf atau karakter Tionghoa, serta dapat berisi angka, titik (.), garis bawah (_), dan tanda hubung (-).	group1
Description	string	No	Deskripsi kelompok titik akhir. Deskripsi dapat mencapai panjang maksimum 200 karakter dan tidak boleh dimulai dengan `http://` atau `https://`.	EndpointGroup
EndpointGroupRegion	string	Yes	ID wilayah tempat kelompok titik akhir dideploy.	cn-hangzhou
ListenerId	string	Yes	ID listener.	lsr-bp1bpn0kn908w4nbw****
TrafficPercentage	integer	No	Persentase trafik yang didistribusikan ke kelompok titik akhir ketika listener dikaitkan dengan beberapa kelompok titik akhir. Nilai valid: 1 hingga 100.	20
HealthCheckIntervalSeconds	integer	No	Interval pemeriksaan kesehatan, dalam satuan detik.	3
HealthCheckPath	string	No	Jalur yang digunakan untuk pemeriksaan kesehatan.	/healthcheck
HealthCheckPort	integer	No	Port yang digunakan untuk pemeriksaan kesehatan.	20
HealthCheckProtocol	string	No	Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai valid: tcp atau TCP: TCP http atau HTTP: HTTP https atau HTTPS: HTTPS	tcp
ThresholdCount	integer	No	Jumlah pemeriksaan kesehatan berturut-turut yang harus berhasil atau gagal sebelum status titik akhir berubah antara sehat dan tidak sehat. Nilai 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 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). SLB: instans Server Load Balancer (SLB). ALB: instans Application Load Balancer (ALB). OSS: bucket Object Storage Service (OSS). ENI: antarmuka jaringan elastis (ENI). NLB: instans Network Load Balancer (NLB). Catatan Jika Anda menetapkan jenis titik akhir ke ECS, ENI, SLB, ALB, NLB, atau IpTarget, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaVpcEndpoint jika peran tersebut belum ada. Jika Anda menetapkan jenis titik akhir ke ALB, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaAlb jika peran tersebut belum ada. Jika Anda menetapkan jenis titik akhir ke OSS, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaOss jika peran tersebut belum ada. Jika Anda menetapkan jenis titik akhir ke NLB, sistem secara otomatis membuat peran terkait layanan bernama AliyunServiceRoleForGaNlb jika peran tersebut belum ada. Catatan Untuk informasi lebih lanjut, lihat Peran terkait layanan.	Ip
EnableClientIPPreservation	boolean	No	Menentukan apakah akan mempertahankan alamat IP sumber klien. Nilai valid: true: mempertahankan alamat IP sumber klien. false (default): tidak mempertahankan alamat IP sumber klien. Catatan Secara default, fitur ini dinonaktifkan untuk kelompok titik akhir yang dikaitkan dengan listener TCP atau UDP. Anda dapat mengaktifkan fitur ini sesuai kebutuhan bisnis Anda. Secara default, fitur ini diaktifkan untuk kelompok titik akhir yang dikaitkan dengan listener HTTP atau HTTPS. Alamat IP sumber diambil dari bidang header X-Forwarded-For. Fitur ini tidak dapat dinonaktifkan. `EnableClientIPPreservation` dan `EnableProxyProtocol` tidak dapat diatur ke `true` secara bersamaan. Untuk informasi lebih lanjut, lihat Pertahankan alamat IP sumber klien.	false
Weight	integer	Yes	Bobot titik akhir. Nilai valid: 0 hingga 255. Catatan Jika Anda menetapkan bobot titik akhir ke 0, GA akan berhenti mendistribusikan trafik ke titik akhir tersebut. Lakukan dengan hati-hati.	20
EnableProxyProtocol	boolean	No	Menentukan apakah akan menggunakan protokol PROXY untuk mempertahankan alamat IP sumber klien. Nilai valid: true: menggunakan protokol PROXY. false (default): tidak menggunakan protokol PROXY. Catatan Parameter ini hanya dapat dikonfigurasi untuk kelompok titik akhir yang dikaitkan dengan listener TCP. `EnableClientIPPreservation` dan `EnableProxyProtocol` tidak dapat diatur ke `true` secara bersamaan. Untuk informasi lebih lanjut, lihat Pertahankan alamat IP sumber klien.	false
Endpoint	string	Yes	Alamat IP, nama domain, atau ID resource titik akhir. Nilai parameter ini bergantung pada nilai parameter `Type`.	120.1.XX.XX
SubAddress	string	No	Alamat IP pribadi ENI. Catatan Parameter ini hanya berlaku ketika jenis titik akhir diatur ke ENI. Jika Anda mengabaikan parameter ini, alamat IP pribadi utama ENI akan digunakan.	172.168.X.X
VpcId	string	No	ID Virtual Private Cloud (VPC). Anda dapat menentukan maksimal satu ID VPC untuk kelompok titik akhir listener routing cerdas. Catatan Parameter ini wajib hanya ketika jenis titik akhir diatur ke IpTarget.	vpc-bp1quce3451z5b2hv****
VSwitchIds	array	No	Daftar vSwitch di VPC.
	string	No	ID vSwitch. Anda dapat menentukan maksimal dua ID vSwitch untuk kelompok titik akhir listener routing cerdas. Catatan Parameter ini wajib ketika jenis titik akhir adalah IpTarget. vSwitch harus termasuk dalam VPC yang ditentukan oleh parameter VpcId.	vsw-bp12mho4ze51ezagm****
Provider	string	No	Penyedia layanan AI. Tetapkan ke `BAILIAN` untuk menggunakan Alibaba Cloud Model Studio.	BAILIAN
ApiKeys	array	No	Kunci API untuk layanan AI.
	string	No	Kunci API untuk layanan AI.	sk-***********
EndpointRequestProtocol	string	No	Protokol yang digunakan oleh layanan backend. Nilai valid: HTTP (default) HTTPS Catatan Parameter ini hanya tersedia untuk kelompok titik akhir listener HTTP atau HTTPS. Untuk listener HTTP, protokol layanan backend harus HTTP.	HTTP
EndpointProtocolVersion	string	No	Versi protokol layanan backend. Nilai valid: HTTP1.1 (default): HTTP/1.1. HTTP2: HTTP/2. Catatan Parameter ini hanya tersedia ketika `EndpointRequestProtocol` diatur ke HTTPS.	HTTP1.1
EndpointGroupType	string	No	Jenis kelompok titik akhir. Nilai valid: default (default): kelompok titik akhir default. virtual: kelompok titik akhir virtual. Catatan Sebelum membuat kelompok titik akhir virtual untuk listener Lapisan 4, pastikan Anda telah membuat kelompok titik akhir default.	default
PortOverrides	array<object>	No	Pemetaan port listener ke titik akhir.
	object	No	Pemetaan port listener ke titik akhir.
ListenerPort	integer	No	Port listener untuk pemetaan port. Catatan Untuk listener TCP, Anda tidak dapat mengonfigurasi pemetaan port untuk kelompok titik akhir virtual. Jika listener dikaitkan dengan kelompok titik akhir virtual, Anda tidak dapat mengonfigurasi pemetaan port untuk kelompok titik akhir default. Jika kelompok titik akhir default telah dikonfigurasi dengan pemetaan port, Anda tidak dapat menambahkan kelompok titik akhir virtual. Setelah Anda mengonfigurasi pemetaan port, Anda tidak dapat mengubah protokol listener, kecuali beralih antara HTTP dan HTTPS. Saat Anda mengubah range port listener, range baru harus mencakup semua port listener yang digunakan dalam pemetaan port. Misalnya, jika range port listener adalah 80–82 dan port listener dipetakan ke port titik akhir 100–102, Anda tidak dapat mengubah range port listener menjadi 80–81.	443
EndpointPort	integer	No	Port titik akhir untuk pemetaan port.	80
HealthCheckEnabled	boolean	No	Menentukan apakah akan mengaktifkan pemeriksaan kesehatan. Nilai valid: true: mengaktifkan pemeriksaan kesehatan. false: menonaktifkan pemeriksaan kesehatan.	true
Tag	array<object>	No	Tag kelompok titik akhir.
	object	No	Tag kelompok titik akhir.
Key	string	No	Kunci tag. Kunci tag tidak boleh berupa string kosong. Kunci tag dapat mencapai panjang maksimum 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. Nilai tag dapat berupa string kosong. Nilai tag dapat mencapai panjang maksimum 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 valid: true: melakukan dry run. 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. Jika permintaan lolos pemeriksaan, sistem mengembalikan kode status HTTP 2xx dan membuat kelompok titik akhir.	false
HealthCheckHost	string	No	Nama domain yang digunakan untuk pemeriksaan kesehatan.	www.taobao.com
EndpointIpVersion	string	No	Versi IP yang digunakan untuk berkomunikasi dengan layanan backend. Nilai valid: IPv4 (default): GA hanya menggunakan IPv4 untuk berkomunikasi dengan layanan backend. IPv6: GA hanya menggunakan IPv6 untuk berkomunikasi dengan layanan backend. ProtocolAffinity: GA menggunakan versi IP yang sama dengan permintaan klien untuk berkomunikasi dengan layanan backend.	IPv4

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
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
400	Domain.NotFit	The domain is not fit the rule
400	Resource.QuotaFull	The resource quota is exceeded.
400	NotExist.ListenerPort	The listening port %s does not exist.
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.
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	Exist.EndpointGroup	The endpoint group already exists.
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.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.