Gunakan CreateLoadBalancerTCPListener untuk membuat listener TCP - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Membuat Pendengar TCP.

Deskripsi operasi

Catatan

Pendengar TCP yang baru dibuat berada dalam status stopped. Setelah Pendengar TCP dibuat, panggil operasi StartLoadBalancerListener untuk memulai Pendengar TCP agar dapat meneruskan Trafik.

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

slb:CreateLoadBalancerTCPListener

create

AccessControlList

acs:slb:{#regionId}:{#accountId}:acl/{#AclId}

*LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

slb:tag
slb:tag
slb:tag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah Instans Classic Load Balancer (CLB). Anda dapat mengkueri ID wilayah dari daftar Wilayah dan zona atau dengan memanggil operasi DescribeRegions.	cn-hangzhou
LoadBalancerId	string	Yes	ID Instans CLB.	lb-bp1b6c719dfa08ex****
ListenerPort	integer	Yes	Port antarmuka depan yang digunakan oleh Instans CLB. Nilai valid: 1 hingga 65535.	80
BackendServerPort	integer	No	Port backend yang digunakan oleh Instans CLB. Nilai valid: 1 hingga 65535. Parameter ini wajib diisi jika Anda tidak menggunakan kelompok server (tidak menentukan vServerGroupId).	80
Tag	array<object>	No	Tag.
	object	No	Tag.
Key	string	No	Kunci tag Pendengar. Nilai valid N: 1 hingga 20. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag dapat mencapai 64 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	TestKey
Value	string	No	Nilai tag Pendengar. Nilai valid N: 1 hingga 20. Nilai tag dapat berupa string kosong. Panjang nilai tag dapat mencapai 128 karakter dan tidak boleh diawali dengan `acs:`. Nilai tag tidak boleh mengandung `http://` atau `https://`.	TestValue
Bandwidth	integer	Yes	Bandwidth puncak Pendengar. Unit: Mbit/s. Nilai valid: -1: Untuk Instans SLB yang menghadap Internet dengan metode pembayaran berdasarkan transfer data, Anda dapat mengatur bandwidth puncak menjadi -1, yang menunjukkan bandwidth Tanpa Batas. 1 hingga 5120: Untuk Instans SLB yang menghadap Internet dengan metode pembayaran berdasarkan bandwidth, Anda dapat mengatur bandwidth puncak untuk setiap Pendengar. Jumlah nilai bandwidth puncak dari semua Pendengar tidak boleh melebihi bandwidth puncak Instans.	-1
Scheduler	string	No	Algoritma penjadwalan. Nilai valid: wrr (default): server backend dengan bobot lebih tinggi menerima lebih banyak permintaan melalui polling. rr: Permintaan didistribusikan ke server backend sesuai urutan akses. sch: penghashan konsisten berdasarkan alamat IP sumber. Permintaan dari alamat IP sumber yang sama didistribusikan ke server backend yang sama. tch: penghashan konsisten berdasarkan parameter berikut: alamat IP sumber, alamat IP tujuan, Port sumber, dan Port tujuan. Permintaan yang mengandung informasi sama berdasarkan keempat faktor tersebut didistribusikan ke server backend yang sama. Catatan Hanya Instans berkinerja tinggi yang mendukung algoritma penghashan konsisten sch dan tch.	wrr
PersistenceTimeout	integer	No	Periode waktu tunggu persistensi sesi. Unit: detik. Nilai valid: 0 hingga 3600. Nilai default: 0, yang menunjukkan bahwa persistensi sesi dinonaktifkan.	0
EstablishedTimeout	integer	No	Periode waktu tunggu koneksi. Unit: detik. Nilai valid: 10 hingga 900.	500
HealthyThreshold	integer	No	Jumlah pemeriksaan kesehatan berhasil berturut-turut yang harus terjadi sebelum server backend dinyatakan sehat. Status pemeriksaan kesehatan server backend berubah dari fail menjadi success. Nilai valid: 2 hingga 10.	4
UnhealthyThreshold	integer	No	Jumlah pemeriksaan kesehatan gagal berturut-turut yang harus terjadi sebelum server backend dinyatakan tidak sehat. Status pemeriksaan kesehatan server backend berubah dari success menjadi fail. Nilai valid: 2 hingga 10.	4
HealthCheckConnectTimeout	integer	No	Periode waktu tunggu maksimum untuk setiap tanggapan Pemeriksaan kesehatan. Unit: detik. Nilai valid: 1 hingga 300. Nilai default: 5.	100
HealthCheckConnectPort	integer	No	Port yang digunakan untuk pemeriksaan kesehatan. Nilai valid: 1 hingga 65535. Jika parameter ini tidak diatur, port layanan backend (BackendServerPort) akan digunakan untuk pemeriksaan kesehatan.	80
healthCheckInterval	integer	No	Interval antara dua pemeriksaan kesehatan berturut-turut. Unit: detik. Nilai valid: 1 hingga 50.	3
HealthCheckDomain	string	No	Nama domain yang digunakan untuk Pemeriksaan kesehatan. Nilai valid: $_ip: alamat IP pribadi server backend. Jika Anda menentukan $_ip atau tidak menentukan parameter ini, Server Load Balancer menggunakan alamat IP jaringan pribadi setiap server backend sebagai Nama domain untuk Pemeriksaan kesehatan. domain: Nama domain harus memiliki panjang 1 hingga 80 karakter dan hanya dapat mengandung huruf, digit, titik (.), dan tanda hubung (-).	172.XX.XX.6
HealthCheckURI	string	No	URI yang digunakan untuk Pemeriksaan kesehatan. URI harus memiliki panjang 1 hingga 80 karakter dan hanya dapat mengandung huruf, digit, tanda hubung (-), garis miring (/), titik (.), tanda persen (%), tanda pagar (#), dan tanda dan (&). URI tidak boleh hanya berupa garis miring (/) tetapi harus diawali dengan garis miring (/). Anda dapat mengonfigurasi parameter ini ketika Pendengar TCP memerlukan Pemeriksaan kesehatan HTTP. Jika parameter ini tidak dikonfigurasi, Pemeriksaan kesehatan TCP akan dilakukan.	/test/index.html
HealthCheckHttpCode	string	No	Kode status HTTP yang menunjukkan hasil pemeriksaan kesehatan Normal. Pisahkan beberapa kode status HTTP dengan koma (,). Nilai valid: http_2xx (default) http_3xx http_4xx http_5xx	http_2xx,http_3xx
HealthCheckType	string	No	Tipe pemeriksaan kesehatan. Nilai valid: tcp (default) http	tcp
VServerGroupId	string	No	ID kelompok vServer.	rsp-cige6j****
MasterSlaveServerGroupId	string	No	ID kelompok server primer/server sekunder. Catatan Anda hanya dapat menentukan salah satu dari ID Kelompok vServer atau ID kelompok server primer/server sekunder.	rsp-0bfucw****
AclId	string	No	ID daftar kontrol akses (ACL) yang terikat pada pendengar. Catatan Parameter ini wajib diisi ketika parameter AclStatus diatur ke on.	acl-uf60jwfiv6******
AclType	string	No	Tipe Kontrol akses. Nilai valid: white: Hanya permintaan dari alamat IP atau blok CIDR dalam kelompok kebijakan Kontrol akses yang dipilih yang akan diteruskan. Daftar putih berlaku untuk skenario di mana Anda hanya ingin mengizinkan alamat IP tertentu mengakses layanan Anda. Mengonfigurasi daftar putih menimbulkan risiko pada workload Anda. Setelah daftar putih dikonfigurasi, hanya alamat IP dalam daftar putih yang dapat mengakses Pendengar SLB. Jika daftar putih diaktifkan tetapi tidak ada alamat IP yang ditambahkan ke kelompok kebijakan Kontrol akses, Pendengar SLB akan meneruskan semua permintaan. black: Semua permintaan dari alamat IP atau blok CIDR dalam kelompok kebijakan Kontrol akses yang dipilih akan ditolak. blacklist berlaku untuk skenario di mana Anda ingin menolak akses dari alamat IP tertentu. Jika blacklist diaktifkan tetapi tidak ada alamat IP yang ditambahkan ke kelompok kebijakan Kontrol akses, Pendengar SLB akan meneruskan semua permintaan. Catatan Parameter ini hanya berlaku ketika parameter AclStatus diatur ke on.	black
AclStatus	string	No	Apakah akan mengaktifkan kontrol akses. Nilai valid: on: diaktifkan. off (default): dinonaktifkan.	off
Description	string	No	Nama Pendengar kustom. Nama harus memiliki panjang 1 hingga 256 karakter dan dapat mengandung karakter Tionghoa, huruf, digit, tanda hubung (-), garis miring (/), titik (.), dan garis bawah (_).	tcp_80
ConnectionDrain	string	No	Apakah akan mengaktifkan pengurasan koneksi. Nilai valid: on: diaktifkan. off: dinonaktifkan.	off
ConnectionDrainTimeout	integer	No	Periode waktu tunggu pengurasan koneksi. Unit: detik. Nilai valid: 10 hingga 900. Catatan Parameter ini wajib diisi ketika ConnectionDrain diatur ke on.	300
ProxyProtocolV2Enabled	boolean	No	Apakah akan menggunakan Proxy Protocol untuk meneruskan alamat sumber klien ke server backend. Nilai valid: true: diaktifkan. false (default): dinonaktifkan.	false
HealthCheckSwitch	string	No	Apakah akan mengaktifkan pemeriksaan kesehatan. Nilai valid: on (default): diaktifkan. off: dinonaktifkan.	on

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Contoh

Respons sukses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParameterValue.SpecNotSupport	The loadBalancer of shared spec does not support the parameter value, %s.	Nilai parameter yang ditentukan tidak didukung oleh Instans SLB sumber daya bersama.
400	OperationNotSupport.Acl	The cloud box instance does not support acl.	Instans CloudBox tidak mendukung konfigurasi kontrol akses.
400	InvalidParameterValue.RegionNotSupport	The region does not support the parameter value, %s.	Nilai parameter yang ditentukan tidak didukung di wilayah saat ini.
400	Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch	The parameters VServerGroupId or MasterSlaveServerGroupId miss match.
400	IpVersionConflict	The ip version of this LoadBalancer and the Acl is conflict.	Versi IP Instance SLB yang ditentukan bentrok dengan tipe IP yang didukung oleh ACL.
400	InvalidParameterValue.ZoneNotSupport	The zone does not support the parameter value, %s.	Nilai parameter yang ditentukan tidak didukung di zona saat ini.
400	ListenerProcessing	A previous configuration of the listener is pending, please try again later.	Pendengar saat ini sedang dikonfigurasi. Coba lagi nanti.
400	AclNotExist	Acl does not exist.	ACL yang ditentukan tidak ada.
400	InvalidParameter.ListenerPortConflict	There is conflict listener port exists.	Port Pendengar yang ditentukan sudah ada.
400	InvalidParameter.ZoneNotSupport	The zone does not support the parameter %s.	Parameter yang ditentukan tidak didukung di zona saat ini.
400	InvalidParam.VServerGroupId	The specified VServerGroupId is invalid.	Parameter VServerGroupId yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi.
400	MissingParam.HealthCheckConnectPort	The parameter HealthCheckConnectPort is required.	Parameter HealthCheckConnectPort tidak ada.
400	InvalidParam.ListenerPort	The specified ListenerPort is invalid.	ListenerPort yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi setelah Anda melakukan modifikasi.
400	InvalidParam.StartPort	The specified StartPort is invalid.	Parameter StartPort yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi.
400	InvalidParamSize.PortRange	The size of param PortRange is invalid.	Parameter PortRange yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi setelah Anda melakukan perubahan.
400	InvalidParam.EndPort	The specified EndPort is invalid.	EndPort yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi setelah Anda melakukan modifikasi.
400	Duplicated.AclEntry	%s.	%s
400	OperationUnsupported.SetAccessControl	The singleTunnel/anyTunnel loadbalancer does not support config AccessControlList.	Operasi ditolak karena Instance SLB SingleTunnel dan AnyTunnel tidak mendukung konfigurasi ACL.
400	InvalidParam.PortRange	The specified PortRange is invalid.	Parameter PortRange yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi setelah Anda melakukan perubahan.
400	InvalidParameter.RegionNotSupport	The region does not support the parameter: %s.	Parameter yang ditentukan tidak didukung di wilayah saat ini.
400	LbNotSupportTcpssl	You cannot create a TCP SSL type listener for the specified load balancer.	Instans yang ditentukan tidak mendukung pembuatan pendengar tipe TCP/SSL.
400	LbSupportTcpsslOnly	The specified load balancer supports TCP SSL type listener only.	Instans yang ditentukan hanya mendukung pembuatan pendengar tipe TCP/SSL.
400	ListenerNotSupportRule	You cannot create a rule for the specified listener.	Pendengar yang ditentukan tidak mendukung pembuatan aturan pengalihan.
400	ListenerPortConflict	The specified ListenerPort is conflict with other listener.	Port pendengar yang ditentukan sudah digunakan.
400	ResourceNotFound.VServerGroup	%s.	Kelompok server yang ditentukan tidak ada.
400	IllegalParam.FailoverThreshold	The parameter FailoverThreshold is illegal.	FailoverThreshold yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi setelah modifikasi.
400	IllegalParam.FailoverStrategy	The parameter FailoverStrategy is illegal.	FailoverStrategy yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi setelah modifikasi.
400	MasterSlaveServerConflict	The servers are conflict for MasterSlaveGroup.	server backend dalam kelompok server primer/server sekunder saling bentrok.
400	OperationDenied.HealthCheckClosedForMasterSlaveMode	The operation is denied because of HealthCheckClosedForMasterSlaveMode.	Operasi ditolak karena pemeriksaan kesehatan harus diaktifkan dalam mode utama/sekunder.
400	IllegalParam.HealthCheck	The param of HelathCheck is illegal.	HealthCheck yang ditentukan tidak valid. Periksa batasan parameter dan coba lagi.
400	Mismatch.SlbSpecTypeAndListenerProtocol	The SlbSpecType and ListenerProtocol are mismatched.	Tipe spesifikasi Instans tidak cocok dengan tipe pendengar.
400	OperationDenied.FullNatModeNotAllowed	The operation is not allowed because of FullNatModeNotAllowed.	Operasi ditolak karena mode NAT Penuh tidak didukung.
400	OperationDenied.OnlyIpv4SlbSupport	The operation is not allowed because of OnlyIpv4SlbSupport.	Operasi ditolak karena hanya Instans IPv4 yang mendukung pengaktifan mode NAT Penuh.
400	SpecNotSupportParameter	The instance with share spec does not support FullNatEnabled parameter.	Instans resource yang dibagikan tidak mendukung parameter FullNatEnabled.
400	InvalidParam.TagValue	%s.
400	InvalidParam.TagKey	%s.
400	SizeLimitExceeded.Tag	%s.
400	MissingParam.TagKey	The param MissingParam.TagKey is missing.
400	MissingParameter	The BackendServerPort or VServerGroupId is required at lease one.	Parameter ListenerPort diperlukan.
400	AclListenerOverLimit	This acl has reached the limit of binding to listeners.	Jumlah Pendengar yang dapat dikaitkan dengan ACL yang ditentukan telah mencapai batas Kuota.
400	QuotaLimitExceeds.AclAttachedToListener	The number of Acl bound listeners has reached the quota limit	Jumlah pendengar yang terkait dengan ACL telah mencapai batas kuota.
400	QuotaLimitExceeds.TotalAclEntry	The number of Acl entries has reached the quota limit.	Jumlah entri ACL telah mencapai batas kuota.
400	QuotaLimitExceeds.AclListenerOverLimit	This acl has reached the limit of binding to listeners.	Jumlah Pendengar yang dapat dikaitkan dengan ACL yang ditentukan telah mencapai batas Kuota.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.