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

Membuat grup endpoint.

Deskripsi operasi

Sebelum Anda membuat grup endpoint virtual untuk listener Layer 4, Anda harus terlebih dahulu membuat grup endpoint default.
CreateEndpointGroup adalah operasi asinkron. Setelah Anda mengirim permintaan, sistem akan mengembalikan ID grup endpoint dan mulai membuat grup endpoint di latar belakang. Anda dapat memanggil DescribeEndpointGroup untuk menanyakan status grup endpoint:
- Jika grup endpoint berada dalam status init, grup tersebut sedang dibuat. Dalam status ini, Anda hanya dapat melakukan operasi kueri.
- Jika grup endpoint berada dalam status active, grup tersebut telah dibuat.
Anda tidak dapat melakukan panggilan bersamaan ke operasi CreateEndpointGroup 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: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 region tempat instance Global Accelerator (GA) di-deploy. Setel nilainya ke cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat membuat token ini, tetapi Anda harus memastikan token tersebut unik untuk setiap permintaan. Token hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem akan secara otomatis menggunakan RequestId dari permintaan sebagai ClientToken. Setiap permintaan memiliki RequestId yang unik.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	ID instance GA.	ga-bp1odcab8tmno0hdq****
Name	string	No	Nama grup endpoint. Nama harus terdiri dari 1 hingga 128 karakter, dimulai dengan huruf atau karakter Tionghoa, dan dapat berisi angka, titik (.), garis bawah (_), serta tanda hubung (-).	group1
Description	string	No	Deskripsi grup endpoint. Deskripsi dapat memiliki panjang hingga 200 karakter dan tidak boleh dimulai dengan `http://` atau `https://`.	EndpointGroup
EndpointGroupRegion	string	Yes	ID region tempat grup endpoint di-deploy.	cn-hangzhou
ListenerId	string	Yes	ID listener.	lsr-bp1bpn0kn908w4nbw****
TrafficPercentage	integer	No	Persentase trafik yang didistribusikan ke grup endpoint ketika listener dikaitkan dengan beberapa grup endpoint. Nilai yang valid: 1 hingga 100.	20
HealthCheckIntervalSeconds	integer	No	Interval pemeriksaan kesehatan, dalam detik.	3
HealthCheckPath	string	No	Path 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 yang 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 endpoint berubah antara sehat dan tidak sehat. Nilai yang valid: 2 hingga 10. Nilai default: 3.	3
EndpointConfigurations	array<object>	No	Konfigurasi endpoint.
	object	No	Konfigurasi endpoint.
Type	string	Yes	Tipe endpoint. Nilai yang valid: Domain: nama domain kustom. Ip: alamat IP kustom. IpTarget: alamat IP privat kustom. PublicIp: alamat IP publik Alibaba Cloud. ECS: instance Elastic Compute Service (ECS). SLB: instance Server Load Balancer (SLB). ALB: instance Application Load Balancer (ALB). OSS: bucket Object Storage Service (OSS). ENI: elastic network interface (ENI). NLB: instance Network Load Balancer (NLB). Catatan Jika Anda mengatur tipe endpoint ke ECS, ENI, SLB, ALB, NLB, atau IpTarget, sistem akan secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaVpcEndpoint jika role tersebut belum ada. Jika Anda mengatur tipe endpoint ke ALB, sistem akan secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaAlb jika role tersebut belum ada. Jika Anda mengatur tipe endpoint ke OSS, sistem akan secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaOss jika role tersebut belum ada. Jika Anda mengatur tipe endpoint ke NLB, sistem akan secara otomatis membuat service-linked role bernama AliyunServiceRoleForGaNlb jika role tersebut belum ada. Catatan Untuk informasi lebih lanjut, lihat Service-linked roles.	Ip
EnableClientIPPreservation	boolean	No	Menentukan apakah akan mempertahankan alamat IP sumber klien. Nilai yang valid: true: mempertahankan alamat IP sumber klien. false (default): tidak mempertahankan alamat IP sumber klien. Catatan Secara default, fitur ini dinonaktifkan untuk grup endpoint yang dikaitkan dengan listener TCP atau UDP. Anda dapat mengaktifkan fitur ini berdasarkan kebutuhan bisnis Anda. Secara default, fitur ini diaktifkan untuk grup endpoint yang dikaitkan dengan listener HTTP atau HTTPS. Alamat IP sumber diambil dari field header X-Forwarded-For. Fitur ini tidak dapat dinonaktifkan. `EnableClientIPPreservation` dan `EnableProxyProtocol` tidak dapat sama-sama disetel ke `true`. Untuk informasi lebih lanjut, lihat Pertahankan alamat IP sumber klien.	false
Weight	integer	Yes	Bobot endpoint. Nilai yang valid: 0 hingga 255. Catatan Jika Anda mengatur bobot suatu endpoint ke 0, GA akan berhenti mendistribusikan trafik ke endpoint tersebut. Lanjutkan dengan hati-hati.	20
EnableProxyProtocol	boolean	No	Menentukan apakah akan menggunakan protokol PROXY untuk mempertahankan alamat IP sumber klien. Nilai yang valid: true: menggunakan protokol PROXY. false (default): tidak menggunakan protokol PROXY. Catatan Parameter ini hanya dapat dikonfigurasi untuk grup endpoint yang dikaitkan dengan listener TCP. `EnableClientIPPreservation` dan `EnableProxyProtocol` tidak dapat sama-sama disetel ke `true`. Untuk informasi lebih lanjut, lihat Pertahankan alamat IP sumber klien.	false
Endpoint	string	Yes	Alamat IP, nama domain, atau ID sumber daya dari endpoint. Nilai parameter ini bergantung pada nilai parameter `Type`.	120.1.XX.XX
SubAddress	string	No	Alamat IP privat dari ENI. Catatan Parameter ini hanya berlaku ketika tipe endpoint disetel ke ENI. Jika Anda menghilangkan parameter ini, alamat IP privat utama ENI akan digunakan.	172.168.X.X
VpcId	string	No	ID Virtual Private Cloud (VPC). Anda dapat menentukan paling banyak satu ID VPC untuk grup endpoint dari listener intelligent routing. Catatan Parameter ini wajib hanya ketika tipe endpoint disetel ke IpTarget.	vpc-bp1quce3451z5b2hv****
VSwitchIds	array	No	Daftar vSwitch di VPC.
	string	No	ID vSwitch. Anda dapat menentukan maksimal dua ID vSwitch untuk grup endpoint dari listener intelligent routing. Catatan Parameter ini wajib ketika tipe endpoint adalah IpTarget. vSwitch harus termasuk dalam VPC yang ditentukan oleh parameter VpcId.	vsw-bp12mho4ze51ezagm****
Provider	string	No		BAILIAN
ApiKeys	array	No
	string	No		sk-***********
EndpointRequestProtocol	string	No	Protokol yang digunakan oleh backend service. Nilai yang valid: HTTP (default) HTTPS Catatan Parameter ini hanya tersedia untuk grup endpoint dari listener HTTP atau HTTPS. Untuk listener HTTP, protokol backend service harus HTTP.	HTTP
EndpointProtocolVersion	string	No	Versi protokol backend service. Nilai yang valid: HTTP1.1 (default): HTTP/1.1. HTTP2: HTTP/2. Catatan Parameter ini hanya tersedia ketika `EndpointRequestProtocol` disetel ke HTTPS.	HTTP1.1
EndpointGroupType	string	No	Tipe grup endpoint. Nilai yang valid: default (default): grup endpoint default. virtual: grup endpoint virtual. Catatan Sebelum Anda membuat grup endpoint virtual untuk listener Layer 4, pastikan Anda telah membuat grup endpoint default.	default
PortOverrides	array<object>	No	Pemetaan port listener-ke-endpoint.
	object	No	Pemetaan port listener-ke-endpoint.
ListenerPort	integer	No	Port listener untuk pemetaan port. Catatan Untuk listener TCP, Anda tidak dapat mengonfigurasi pemetaan port untuk grup endpoint virtual. Jika listener dikaitkan dengan grup endpoint virtual, Anda tidak dapat mengonfigurasi pemetaan port untuk grup endpoint default. Jika grup endpoint default memiliki pemetaan port yang dikonfigurasi, Anda tidak dapat menambahkan grup endpoint virtual. Setelah Anda mengonfigurasi pemetaan port, Anda tidak dapat mengubah protokol listener, kecuali untuk beralih antara HTTP dan HTTPS. Ketika Anda memodifikasi rentang port listener, rentang baru harus mencakup semua port listener yang digunakan dalam pemetaan port. Misalnya, jika rentang port listener adalah 80-82 dan port listener dipetakan ke port endpoint 100-102, Anda tidak dapat mengubah rentang port listener menjadi 80-81.	443
EndpointPort	integer	No	Port endpoint untuk pemetaan port.	80
HealthCheckEnabled	boolean	No	Menentukan apakah akan mengaktifkan pemeriksaan kesehatan. Nilai yang valid: true: mengaktifkan pemeriksaan kesehatan. false: menonaktifkan pemeriksaan kesehatan.	true
Tag	array<object>	No	Tag dari grup endpoint.
	object	No	Tag dari grup endpoint.
Key	string	No	Kunci tag. Kunci tag tidak boleh berupa string kosong. Kunci tag dapat memiliki panjang hingga 64 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Tidak boleh berisi `http://` atau `https://`. Anda dapat menentukan hingga 20 kunci tag.	test-key
Value	string	No	Nilai tag. Nilai tag boleh berupa string kosong. Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Tidak boleh berisi `http://` atau `https://`. Anda dapat menentukan hingga 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 wajib, format permintaan, dan batasan layanan. Jika permintaan gagal dry run, sistem akan mengembalikan pesan kesalahan. Jika permintaan berhasil melewati dry run, sistem akan mengembalikan kode status HTTP 2xx. false (default): mengirimkan permintaan normal. Jika permintaan lulus pemeriksaan, sistem akan mengembalikan kode status HTTP 2xx dan membuat grup endpoint.	false
HealthCheckHost	string	No	Nama domain yang digunakan untuk pemeriksaan kesehatan.	www.taobao.com
EndpointIpVersion	string	No	Versi IP yang digunakan untuk berkomunikasi dengan backend service. Nilai yang valid: IPv4 (default): GA hanya menggunakan IPv4 untuk berkomunikasi dengan backend service. IPv6: GA hanya menggunakan IPv6 untuk berkomunikasi dengan backend service. ProtocolAffinity: GA menggunakan versi IP yang sama dengan permintaan klien untuk berkomunikasi dengan backend service.	IPv4

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
EndpointGroupId	string	ID grup endpoint.	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.