All Products
Search

This Product

    Server Load Balancer:CreateListener

    Document Center

    Server Load Balancer:CreateListener

    Last Updated:Jun 10, 2026

    Membuat listener.

    Deskripsi operasi

    Operasi CreateListener adalah operasi asinkron. Permintaan yang berhasil mengembalikan ID permintaan, tetapi listener dibuat di latar belakang. Panggil GetListenerAttribute untuk menanyakan status pembuatan listener:

    • Status Provisioning menunjukkan bahwa listener sedang dibuat.

    • Status Running menunjukkan bahwa listener telah berhasil dibuat.

    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

    alb:CreateListener

    create

    *LoadBalancer

    acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

    *SecurityPolicy

    acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}

    *ServerGroup

    acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}
    • alb:ListenerProtocol
    		 None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    LoadBalancerId

    string

    Yes

    ID dari instance Application Load Balancer (ALB).

    alb-n5qw04uq8vavfe****
    ClientToken

    string

    No

    Token yang dihasilkan oleh klien yang digunakan untuk memastikan idempotensi permintaan. Token harus unik di antara permintaan yang berbeda dan hanya boleh berisi karakter ASCII.

    Catatan

    Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId bersifat unik untuk setiap permintaan API.

    123e4567-e89b-12d3-a456-426655440000
    DryRun

    boolean

    No

    Menentukan apakah akan melakukan dry run. Nilai yang valid:

    • true: Melakukan dry run untuk memeriksa potensi masalah pada permintaan, termasuk parameter yang diperlukan, format permintaan, dan batas layanan. Listener tidak dibuat. Jika permintaan gagal pemeriksaan, sistem mengembalikan error. Jika permintaan lolos pemeriksaan, sistem mengembalikan kode error DryRunOperation.

    • false (default): Mengirim permintaan. Jika permintaan lolos pemeriksaan, sistem melakukan operasi tersebut dan mengembalikan kode status HTTP 2xx.

    false
    ListenerProtocol

    string

    Yes

    Protokol listener.

    Nilai yang valid: HTTP, HTTPS, dan QUIC.

    HTTP
    ListenerPort

    integer

    Yes

    Port frontend yang digunakan oleh listener.

    Nilai yang valid: 1 hingga 65535.

    80
    ListenerDescription

    string

    No

    Nama kustom untuk listener.

    Nama harus terdiri dari 2 hingga 256 karakter dan boleh berisi huruf, angka, tanda hubung (-), garis miring (/), titik (.), garis bawah (_), dan karakter Tionghoa.

    HTTP_80
    RequestTimeout

    integer

    No

    Batas waktu permintaan dalam detik.

    Nilai yang valid: 1 hingga 600.

    Nilai default: 60.

    Jika server backend tidak merespons dalam periode batas waktu, load balancer mengembalikan error HTTP 504 kepada klien.

    Catatan

    Anda dapat meminta peningkatan kuota hingga maksimum 3.600 detik.

    60
    IdleTimeout

    integer

    No

    Batas waktu idle dalam detik.

    Nilai yang valid: 1 hingga 600.

    Nilai default: 15.

    Jika tidak ada permintaan yang diterima pada koneksi dalam batas waktu idle, load balancer menutup koneksi tersebut. Koneksi baru dibuat untuk permintaan berikutnya.

    Catatan

    Anda dapat meminta peningkatan kuota hingga maksimum 3.600 detik.

    3
    GzipEnabled

    boolean

    No

    Menentukan apakah akan mengaktifkan kompresi Gzip untuk mengompresi jenis file tertentu. Nilai yang valid:

    • true (default): Mengaktifkan kompresi Gzip.

    • false: Menonaktifkan kompresi Gzip.

    true
    Http2Enabled

    boolean

    No

    Menentukan apakah akan mengaktifkan HTTP/2. Nilai yang valid:

    • true (default): Mengaktifkan HTTP/2.

    • false: Menonaktifkan HTTP/2.

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    true
    SecurityPolicyId

    string

    No

    ID dari kebijakan keamanan. Baik kebijakan keamanan sistem maupun kustom didukung.

    Nilai default: tls_cipher_policy_1_0 (kebijakan keamanan sistem).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    tls_cipher_policy_1_0
    CaEnabled

    boolean

    No

    Menentukan apakah akan mengaktifkan autentikasi bersama (mutual authentication). Nilai yang valid:

    • true: Mengaktifkan autentikasi bersama.

    • false (default): Menonaktifkan autentikasi bersama.

    false
    XForwardedForConfig

    object

    No

    Konfigurasi header X-Forwarded-*.

    XForwardedForClientCertClientVerifyAlias

    string

    No

    Nama header kustom. Parameter ini berlaku hanya ketika XForwardedForClientCertClientVerifyEnabled diatur ke true.

    Nama harus terdiri dari 1 hingga 40 karakter dan boleh berisi huruf kecil, angka, tanda hubung (-), dan garis bawah (_).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    test_client-verify-alias_123456
    XForwardedForClientCertClientVerifyEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Client-Cert-Client-Verify untuk mengambil hasil verifikasi sertifikat klien. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    true
    XForwardedForClientCertFingerprintAlias

    string

    No

    Nama header kustom. Parameter ini berlaku hanya ketika XForwardedForClientCertFingerprintEnabled diatur ke true.

    Nama harus terdiri dari 1 hingga 40 karakter dan boleh berisi huruf kecil, angka, tanda hubung (-), dan garis bawah (_).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    test_finger-print-alias_123456
    XForwardedForClientCertFingerprintEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Client-Cert-Fingerprint untuk mengambil sidik jari sertifikat klien. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    true
    XForwardedForClientCertIssuerDNAlias

    string

    No

    Nama header kustom. Parameter ini berlaku hanya ketika XForwardedForClientCertIssuerDNEnabled diatur ke true.

    Nama harus terdiri dari 1 hingga 40 karakter dan boleh berisi huruf kecil, angka, tanda hubung (-), dan garis bawah (_).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    test_issue-dn-alias_123456
    XForwardedForClientCertIssuerDNEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Client-Cert-Issuer-DN untuk mengambil informasi tentang penerbit sertifikat klien. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    true
    XForwardedForClientCertSubjectDNAlias

    string

    No

    Nama header kustom. Parameter ini berlaku hanya ketika XForwardedForClientCertSubjectDNEnabled diatur ke true.

    Nama harus terdiri dari 1 hingga 40 karakter dan boleh berisi huruf kecil, angka, tanda hubung (-), dan garis bawah (_).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    test_subject-dn-alias_123456
    XForwardedForClientCertSubjectDNEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Client-Cert-Subject-DN untuk mengambil informasi tentang pemilik sertifikat klien. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    true
    XForwardedForClientSrcPortEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Client-Srcport untuk mengambil port sumber dari klien. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini tersedia untuk listener HTTP dan HTTPS.

    true
    XForwardedForEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-For untuk mengambil alamat IP klien. Nilai yang valid:

    • true (default): Mengaktifkan fitur ini.

    • false: Menonaktifkan fitur ini.

    Catatan

    1. Jika Anda mengatur parameter ini ke true, nilai default dari XForwardedForProcessingMode adalah append. Anda dapat mengubah nilainya menjadi remove.

    2. Jika Anda mengatur parameter ini ke false, ALB mempertahankan header X-Forwarded-For dan tidak melakukan pemrosesan tambahan sebelum mengirimkan permintaan ke server backend.

    3. Parameter ini tersedia untuk listener HTTP dan HTTPS.

    true
    XForwardedForProcessingMode

    string

    No

    Mode yang digunakan untuk memproses header X-Forwarded-For. Parameter ini berlaku hanya ketika XForwardedForEnabled diatur ke true. Nilai yang valid:

    • append (default): Menambahkan alamat IP dari hop terakhir ke header X-Forwarded-For.

    • remove: Menghapus header X-Forwarded-For.

    Catatan

    1. Jika Anda mengatur nilainya ke append, ALB menambahkan alamat IP dari hop terakhir ke header X-Forwarded-For sebelum mengirimkan permintaan ke server backend.

    2. Jika Anda mengatur nilainya ke remove, ALB menghapus header X-Forwarded-For sebelum mengirimkan permintaan ke server backend, terlepas dari apakah permintaan berisi header X-Forwarded-For atau tidak.

    3. Parameter ini tersedia untuk listener HTTP dan HTTPS.

    append
    XForwardedForProtoEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Proto untuk mengambil protokol listener dari instance ALB. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.

    false
    XForwardedForSLBIdEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header SLB-ID untuk mengambil ID dari instance ALB. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.

    false
    XForwardedForSLBPortEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Port untuk mengambil port listener dari instance ALB. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.

    false
    XForwardedForClientSourceIpsEnabled

    boolean

    No

    Menentukan apakah akan mengizinkan ALB untuk mengambil alamat IP klien dari header X-Forwarded-For. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini tersedia untuk listener HTTP dan HTTPS.

    false
    XForwardedForClientSourceIpsTrusted

    string

    No

    Menentukan alamat IP proxy yang tepercaya.

    ALB menelusuri header X-Forwarded-For dari kanan ke kiri, memilih alamat IP pertama yang tidak ada dalam daftar tepercaya ini sebagai alamat IP klien. IP ini kemudian digunakan untuk fitur seperti throttling berbasis IP sumber.

    10.1.1.0/24
    XForwardedForHostEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Host untuk mengambil nama domain yang digunakan untuk mengakses instance ALB. Nilai yang valid:

    • true: Mengaktifkan fitur ini.

    • false (default): Menonaktifkan fitur ini.

    Catatan

    Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.

    false
    QuicConfig

    object

    No

    Konfigurasi dari listener QUIC yang terkait.

    QuicListenerId

    string

    No

    ID dari listener QUIC yang akan dikaitkan dengan listener. Parameter ini diperlukan untuk listener HTTPS ketika QuicUpgradeEnabled diatur ke true.

    Catatan

    Listener HTTPS dan listener QUIC yang terkait harus berada dalam instance ALB yang sama, dan listener QUIC tidak boleh sudah dikaitkan dengan listener lain.

    lsn-o4u54y73wq7b******
    QuicUpgradeEnabled

    boolean

    No

    Menentukan apakah akan mengaktifkan peningkatan QUIC. Nilai yang valid:

    • true: Mengaktifkan peningkatan QUIC.

    • false (default): Menonaktifkan peningkatan QUIC.

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    false
    Certificates

    array<object>

    No

    Daftar sertifikat server.

    object

    No

    Sertifikat.

    CertificateId

    string

    No

    ID dari sertifikat server default. Hanya satu sertifikat server default yang didukung.

    Catatan

    103705*******
    CaCertificates

    array<object>

    No

    Daftar sertifikat CA untuk listener. Hanya satu sertifikat CA yang didukung.

    object

    No

    Sertifikat CA.

    CertificateId

    string

    No

    ID dari sertifikat CA.

    Catatan

    Parameter ini diperlukan jika CaEnabled diatur ke true.

    123157*******
    DefaultActions

    array<object>

    Yes

    Tindakan default untuk listener.

    array<object>

    Yes

    Daftar tindakan default.

    ForwardGroupConfig

    object

    Yes

    Konfigurasi dari tindakan forward. Anda dapat menentukan hingga 20 tindakan forward.

    ServerGroupTuples

    array<object>

    Yes

    Grup server tujuan.

    object

    Yes

    Grup server tujuan.

    ServerGroupId

    string

    Yes

    The ID of the destination server group.

    sgp-8ilqs4axp6******
    Type

    string

    Yes

    Jenis tindakan.

    Atur ini ke ForwardGroup untuk meneruskan permintaan ke satu atau beberapa grup server.

    ForwardGroup
    Tag

    array<object>

    No

    Daftar tag yang akan ditambahkan ke listener.

    object

    No

    Tag.

    Key

    string

    No

    Kunci tag. Kunci dapat memiliki panjang hingga 128 karakter dan tidak boleh dimulai dengan aliyun atau acs:, atau berisi http:// atau https://.

    env
    Value

    string

    No

    Nilai tag. Nilai dapat memiliki panjang hingga 128 karakter dan tidak boleh dimulai dengan aliyun atau acs:, atau berisi http:// atau https://.

    product

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Detail dari listener yang dibuat

    JobId

    string

    ID tugas asinkron

    72dcd26b-f12d-4c27-b3af-18f6aed5****
    ListenerId

    string

    ID Listener

    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.
    400 IncorrectStatus.LoadBalancer The status of %s [%s] is incorrect.
    400 IncorrectBusinessStatus.LoadBalancer The business status of %s [%s]  is incorrect.
    400 ResourceQuotaExceeded.LoadBalancerListenersNum The quota of %s is exceeded for resource %s, usage %s/%s.
    400 OperationDenied.CrossLoadBalancerQUICListener The operation is not allowed because of %s.
    400 ResourceAlreadyAssociated.Listener The specified resource %s is already associated.
    400 ResourceQuotaExceeded.SecurityPolicyAttachedNum The quota of %s is exceeded for resource %s, usage %s/%s.
    400 ResourceQuotaExceeded.ServerGroupAttachedNum The quota of %s is exceeded for resource %s, usage %s/%s.
    400 ResourceQuotaExceeded.LoadBalancerServersNum The quota of %s is exceeded for resource %s, usage %s/%s.
    400 ResourceQuotaExceeded.ServerAddedNum The quota of %s is exceeded for resource %s, usage %s/%s.
    400 Mismatch.VpcId The %s is mismatched for %s and %s.
    400 OperationDenied.ServerGroupProtocolNotSupport The operation is not allowed because of ServerGroupProtocolNotSupport.
    400 OperationDenied.GRPCServerGroup The operation is not allowed because of %s.
    400 Mismatch.LoadBalancerEditionAndConnectionDrain The %s and %s are mismatched.
    400 Mismatch.LoadBalancerEditionAndSlowStartEnable The %s and %s are mismatched.
    400 InvalidParameter Invalid parameter, please check the parameter input.
    400 OperationDenied.CACertificateCorrupted The CA certificate is corrupted.
    403 Forbidden.SecurityPolicy Authentication has failed for SecurityPolicy.
    403 Forbidden.LoadBalancer Authentication is failed for %s.
    403 Forbidden.Listener Authentication is failed for %s.
    404 ResourceNotFound.LoadBalancer The specified resource %s is not found.
    404 ResourceNotFound.ServerGroup The specified resource %s is not found.
    404 ResourceNotFound.SecurityPolicy The specified resource %s is not found.
    404 ResourceNotFound.Listener The specified resource %s is not found.
    404 ResourceNotFound.Certificate The specified resource %s is not found.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.