Membuat pendengar.
Deskripsi operasi
CreateListener adalah operasi asinkron. Setelah ID permintaan dikembalikan, pendengar HTTP, HTTPS, atau QUIC mungkin belum dibuat karena sistem masih memproses tugas pembuatan di latar belakang. Anda dapat memanggil GetListenerAttribute untuk mengkueri status pembuatan pendengar HTTP, HTTPS, atau QUIC:
Jika pendengar HTTP, HTTPS, atau QUIC berada dalam status Provisioning, pendengar sedang dibuat.
Jika pendengar HTTP, HTTPS, atau QUIC berada dalam status Running, pendengar telah dibuat.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
alb:CreateListener |
create |
*LoadBalancer
*SecurityPolicy
*ServerGroup
|
|
None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| LoadBalancerId |
string |
Yes |
ID instans Application Load Balancing (ALB). |
alb-n5qw04uq8vavfe**** |
| ClientToken |
string |
No |
Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara berbagai permintaan. Token hanya dapat berisi karakter ASCII. Catatan
Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan API. |
123e4567-e89b-12d3-a456-426655440000 |
| DryRun |
boolean |
No |
Apakah akan menjalankan dry run saja, tanpa menjalankan permintaan aktual. Nilai valid:
|
false |
| ListenerProtocol |
string |
Yes |
Protokol pendengar. Nilai valid: HTTP, HTTPS, dan QUIC. |
HTTP |
| ListenerPort |
integer |
Yes |
Port antarmuka depan yang digunakan oleh instans load balancing. Nilai valid: 1 hingga 65535. |
80 |
| ListenerDescription |
string |
No |
Nama kustom pendengar. Panjang nama harus 2 hingga 256 karakter, dan dapat berisi huruf, digit, tanda hubung (-), garis miring (/), titik (.), dan garis bawah (_). |
HTTP_80 |
| RequestTimeout |
integer |
No |
Periode waktu tunggu permintaan. Unit: detik. Nilai valid: 1 hingga 600. Nilai default: 60. Jika tidak ada tanggapan yang diterima dari server backend dalam periode waktu tunggu, load balancing mengirimkan kode kesalahan Catatan
Anda dapat mengajukan permintaan peningkatan kuota untuk meningkatkan periode waktu tunggu permintaan hingga maksimum 3600 detik. |
60 |
| IdleTimeout |
integer |
No |
Periode waktu tunggu koneksi idle. Unit: detik. Nilai valid: 1 hingga 600. Nilai default: 15. Jika tidak ada permintaan akses yang diterima dalam periode waktu tunggu, load balancing memutuskan sementara koneksi saat ini. Ketika permintaan berikutnya tiba, koneksi baru akan dibuat. Catatan
Anda dapat mengajukan permintaan peningkatan kuota untuk meningkatkan periode waktu tunggu koneksi idle hingga maksimum 3600 detik. |
3 |
| GzipEnabled |
boolean |
No |
Apakah akan mengaktifkan kompresi
|
true |
| Http2Enabled |
boolean |
No |
Apakah akan mengaktifkan
Catatan
Hanya pendengar HTTPS yang mendukung parameter ini. |
true |
| SecurityPolicyId |
string |
No |
ID kebijakan keamanan. Kebijakan keamanan sistem dan kebijakan keamanan kustom didukung. Nilai default: tls_cipher_policy_1_0 (kebijakan keamanan sistem). Catatan
Hanya pendengar HTTPS yang mendukung parameter ini. |
tls_cipher_policy_1_0 |
| CaEnabled |
boolean |
No |
Apakah akan mengaktifkan otentikasi timbal balik. Nilai valid:
|
false |
| XForwardedForConfig |
object |
No |
Konfigurasi bidang XForward. |
|
| XForwardedForClientCertClientVerifyAlias |
string |
No |
Nama Header Kustom. Parameter ini berlaku hanya jika XForwardedForClientCertClientVerifyEnabled diatur ke true. Panjang nilai harus 1 hingga 40 karakter, dan dapat berisi huruf kecil a hingga z, tanda hubung (-), garis bawah (_), dan digit. Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
test_Klien-verify-alias_123456 |
| XForwardedForClientCertClientVerifyEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
true |
| XForwardedForClientCertFingerprintAlias |
string |
No |
Nama Header Kustom. Parameter ini berlaku hanya jika XForwardedForClientCertFingerprintEnabled diatur ke true. Panjang nilai harus 1 hingga 40 karakter, dan dapat berisi huruf kecil a hingga z, tanda hubung (-), garis bawah (_), dan digit. Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
test_finger-print-alias_123456 |
| XForwardedForClientCertFingerprintEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
true |
| XForwardedForClientCertIssuerDNAlias |
string |
No |
Nama Header Kustom. Parameter ini berlaku hanya jika XForwardedForClientCertIssuerDNEnabled diatur ke true. Panjang nilai harus 1 hingga 40 karakter, dan dapat berisi huruf kecil a hingga z, tanda hubung (-), garis bawah (_), dan digit. Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
test_issue-dn-alias_123456 |
| XForwardedForClientCertIssuerDNEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
true |
| XForwardedForClientCertSubjectDNAlias |
string |
No |
Nama Header Kustom. Parameter ini berlaku hanya jika XForwardedForClientCertSubjectDNEnabled diatur ke true. Panjang nilai harus 1 hingga 40 karakter, dan dapat berisi huruf kecil a hingga z, tanda hubung (-), garis bawah (_), dan digit. Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
test_subject-dn-alias_123456 |
| XForwardedForClientCertSubjectDNEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
true |
| XForwardedForClientSrcPortEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Pendengar HTTP dan HTTPS mendukung parameter ini. |
true |
| XForwardedForEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
|
true |
| XForwardedForProcessingMode |
string |
No |
Mode untuk memproses header
Catatan
|
append |
| XForwardedForProtoEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Pendengar HTTP, HTTPS, dan QUIC mendukung parameter ini. |
false |
| XForwardedForSLBIdEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Pendengar HTTP, HTTPS, dan QUIC mendukung parameter ini. |
false |
| XForwardedForSLBPortEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Pendengar HTTP, HTTPS, dan QUIC mendukung parameter ini. |
false |
| XForwardedForClientSourceIpsEnabled |
boolean |
No |
Apakah akan mengizinkan ALB mencari alamat IP klien asli di header X-Forwarded-For. Nilai valid:
Catatan
Pendengar HTTP dan HTTPS mendukung parameter ini. |
false |
| XForwardedForClientSourceIpsTrusted |
string |
No |
Alamat IP proxy tepercaya. Application Load Balancing (ALB) menelusuri header |
10.1.1.0/24 |
| XForwardedForHostEnabled |
boolean |
No |
Apakah akan menggunakan header
Catatan
Pendengar HTTP, HTTPS, dan QUIC mendukung parameter ini. |
false |
| QuicConfig |
object |
No |
Konfigurasi Pendengar QUIC yang terkait. |
|
| QuicListenerId |
string |
No |
ID Pendengar QUIC yang akan dikaitkan. Parameter ini valid untuk Pendengar HTTPS. Parameter ini diperlukan ketika QuicUpgradeEnabled diatur ke true. Catatan
Pendengar asli dan Pendengar QUIC yang terkait harus berada dalam Instans ALB yang sama, dan Pendengar QUIC tidak boleh pernah dikaitkan sebelumnya. |
lsn-o4u54y73wq7b****** |
| QuicUpgradeEnabled |
boolean |
No |
Apakah akan mengaktifkan Peningkatan QUIC. Nilai valid:
Catatan
Hanya Pendengar HTTPS yang mendukung parameter ini. |
false |
| Certificates |
array<object> |
No |
Informasi daftar Sertifikat. |
|
|
object |
No |
Struktur Sertifikat. |
||
| CertificateId |
string |
No |
ID Sertifikat default. Hanya satu Sertifikat server default yang didukung. Catatan
|
103705******* |
| CaCertificates |
array<object> |
No |
Daftar Sertifikat CA yang dikonfigurasi untuk Pendengar. Hanya satu Sertifikat CA yang didukung. |
|
|
object |
No |
Struktur Sertifikat CA yang dikonfigurasi untuk Pendengar. |
||
| CertificateId |
string |
No |
ID Sertifikat CA. Catatan
Parameter ini diperlukan ketika CaEnabled diatur ke true. |
123157******* |
| DefaultActions |
array<object> |
Yes |
Daftar aksi aturan. |
|
|
array<object> |
Yes |
Daftar aksi aturan. |
||
| ForwardGroupConfig |
object |
Yes |
Konfigurasi aksi penerusan. Anda dapat menambahkan hingga 20 konfigurasi aksi penerusan. |
|
| ServerGroupTuples |
array<object> |
Yes |
Tuple kelompok server tujuan penerusan. |
|
|
object |
Yes |
Tuple kelompok server tujuan penerusan. |
||
| ServerGroupId |
string |
Yes |
ID kelompok server tujuan tempat permintaan diteruskan. |
sgp-8ilqs4axp6****** |
| Type |
string |
Yes |
Tipe aksi. Anda dapat menambahkan hingga 1 tipe aksi. Nilai valid: ForwardGroup: meneruskan permintaan ke beberapa kelompok server. |
ForwardGroup |
| Tag |
array<object> |
No |
Tag. |
|
|
object |
No |
Struktur tag. |
||
| Key |
string |
No |
Kunci tag. Panjang kunci tag dapat mencapai 128 karakter. Tidak boleh diawali dengan aliyun atau acs: dan tidak boleh mengandung http:// atau https://. |
env |
| Value |
string |
No |
Nilai tag. Panjang nilai tag dapat mencapai 128 karakter. Tidak boleh diawali dengan aliyun atau acs: dan tidak boleh mengandung http:// atau https://. |
product |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Tanggapan untuk membuat pendengar. |
||
| JobId |
string |
ID tugas asinkron. |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| ListenerId |
string |
ID pendengar. |
lsn-o4u54y73wq7b****** |
| RequestId |
string |
ID permintaan. |
CEF72CEB-54B6-4AE8-B225-F876******* |
Contoh
Respons sukses
JSONformat
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"ListenerId": "lsn-o4u54y73wq7b******",
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876*******"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ResourceAlreadyExist.Listener | The specified resource %s is already exist. | Pendengar dengan Port yang sama sudah ada. |
| 400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | Status Port instans saat ini tidak mendukung operasi ini. |
| 400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | Status instans saat ini tidak mendukung operasi ini. |
| 400 | ResourceQuotaExceeded.LoadBalancerListenersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | Kuota %s telah terlampaui. Resource adalah %s, penggunaan saat ini adalah %s, dan kuota adalah %s. |
| 400 | OperationDenied.CrossLoadBalancerQUICListener | The operation is not allowed because of %s. | Operasi ditolak karena %s. |
| 400 | ResourceAlreadyAssociated.Listener | The specified resource %s is already associated. | Sumber daya %s sudah dikaitkan. |
| 400 | ResourceQuotaExceeded.SecurityPolicyAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | Kuota %s telah terlampaui. Resource adalah %s, penggunaan saat ini adalah %s, dan kuota adalah %s. |
| 400 | ResourceQuotaExceeded.ServerGroupAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | Jumlah asosiasi untuk kelompok server telah melebihi batas kuota. |
| 400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | Jumlah server backend telah melebihi batas kuota. |
| 400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | Jumlah server yang ditambahkan ke kelompok server telah melebihi batas kuota. |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | %s tidak cocok antara %s dan %s. |
| 400 | OperationDenied.ServerGroupProtocolNotSupport | The operation is not allowed because of ServerGroupProtocolNotSupport. | Operasi ditolak karena protokol kelompok server tidak didukung. |
| 400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | Operasi ditolak karena pendengar yang terkait dengan kelompok server gRPC ini tidak mengaktifkan HTTP/2.0. |
| 400 | Mismatch.LoadBalancerEditionAndConnectionDrain | The %s and %s are mismatched. | Parameter %s dan %s tidak cocok. |
| 400 | Mismatch.LoadBalancerEditionAndSlowStartEnable | The %s and %s are mismatched. | Parameter %s dan %s tidak cocok. |
| 400 | InvalidParameter | Invalid parameter, please check the parameter input. | Parameter tidak valid. Periksa input parameter. |
| 400 | OperationDenied.CACertificateCorrupted | The CA certificate is corrupted. | Sertifikat CA rusak. |
| 403 | Forbidden.SecurityPolicy | Authentication has failed for SecurityPolicy. | Otentikasi gagal untuk SecurityPolicy. |
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. | Otentikasi gagal untuk operasi load balancing. |
| 403 | Forbidden.Listener | Authentication is failed for %s. | Otentikasi gagal untuk pendengar. |
| 404 | ResourceNotFound.LoadBalancer | The specified resource %s is not found. | Resource %s tidak ada. |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | Kelompok server backend tidak ada. |
| 404 | ResourceNotFound.SecurityPolicy | The specified resource %s is not found. | Resource %s tidak ada. |
| 404 | ResourceNotFound.Listener | The specified resource %s is not found. | Pendengar tidak ada. |
| 404 | ResourceNotFound.Certificate | The specified resource %s is not found. | Sertifikat yang ditentukan tidak ada. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.