Tüm Ürünler
Search
Belge Merkezi

:CreateListener

Son Güncelleme:Sep 30, 2026

Bir dinleyici oluşturur.

Operation description

CreateListener eşzamansız bir işlemdir. Bir istek kimliği döndürüldükten sonra, sistem arka planda oluşturma görevini işlemeye devam ettiği için HTTP, HTTPS veya QUIC dinleyicisi henüz oluşturulmamış olabilir. HTTP, HTTPS veya QUIC dinleyicisinin oluşturma durumunu sorgulamak için GetListenerAttribute API'sini çağırabilirsiniz:\n- HTTP, HTTPS veya QUIC dinleyicisi Provisioning durumundaysa dinleyici oluşturuluyor demektir.\n- HTTP, HTTPS veya QUIC dinleyicisi Running durumundaysa dinleyici oluşturulmuş demektir.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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

Request parameters

Parameter

Type

Required

Description

Example

LoadBalancerId

string

Yes

Uygulama Yük Dengeleme (ALB) örneği kimliği.

alb-n5qw04uq8vavfe****

ClientToken

string

No

İsteğin idempotence özelliğini sağlamak için kullanılan istemci belirteci.\n\nBelirteci oluşturmak için istemciyi kullanabilirsiniz, ancak belirtecin farklı istekler arasında benzersiz olduğundan emin olmalısınız. Belirteç yalnızca ASCII karakterleri içerebilir.\n\n> Bu parametreyi belirtmezseniz sistem, API isteğinin RequestId değerini otomatik olarak ClientToken olarak kullanır. RequestId her API isteği için farklı olabilir.

123e4567-e89b-12d3-a456-426655440000

DryRun

boolean

No

Gerçek istek gerçekleştirilmeden yalnızca deneme çalıştırması yapılıp yapılmayacağını belirtir. Geçerli değerler:\n\n- true: Yalnızca deneme çalıştırması yapılır. Sistem; eksik parametre değerleri, hatalı istek sözdizimi ve hizmet limitleri gibi olası sorunlara karşı isteği kontrol eder. İstek deneme çalıştırmasından geçemezse bir hata kodu döndürülür. İstek deneme çalıştırmasından geçerse DryRunOperation hata kodu döndürülür.\n\n- false (varsayılan): Deneme çalıştırması yapılır ve gerçek istek gerçekleştirilir. İstek deneme çalıştırmasından geçerse bir HTTP 2xx durum kodu döndürülür ve işlem gerçekleştirilir.

false

ListenerProtocol

string

Yes

Dinleyici protokolü.\n\nGeçerli değerler: HTTP, HTTPS ve QUIC.

HTTP

ListenerPort

integer

Yes

Yük dengeleme örneği tarafından kullanılan ön uç bağlantı noktası.\n\nGeçerli değerler: 1 ile 65535 arası.

80

ListenerDescription

string

No

Özel dinleyici adı.\n\nAd 2 ila 256 karakter uzunluğunda olmalı ve harf, rakam, tire (-), eğik çizgi (/), nokta (.) ve alt çizgi (_) içerebilir.

HTTP_80

RequestTimeout

integer

No

İstek zaman aşımı süresi. Birim: saniye.\n\nGeçerli değerler: 1 ile 600 arası.\n\nVarsayılan değer: 60.\n\nZaman aşımı süresi içinde arka uç sunucudan yanıt alınamazsa, yük dengeleyici istemciye bir HTTP 504 hata kodu gönderir.\n\n> İstek zaman aşımı süresini en fazla 3600 saniyeye çıkarmak için kota artışı talebi gönderebilirsiniz.

60

IdleTimeout

integer

No

Boşta bağlantı zaman aşımı süresi. Birim: saniye.\n\nGeçerli değerler: 1 ile 600 arası.\n\nVarsayılan değer: 15.\n\nZaman aşımı süresi içinde herhangi bir erişim isteği alınmazsa, yük dengeleyici mevcut bağlantıyı geçici olarak keser. Bir sonraki istek geldiğinde yeni bir bağlantı kurulur.\n\n> Boşta bağlantı zaman aşımı süresini en fazla 3600 saniyeye çıkarmak için kota artışı talebi gönderebilirsiniz.

3

GzipEnabled

boolean

No

Belirli dosya türlerini sıkıştırmak için Gzip sıkıştırmasının etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:\n\n- true (varsayılan): Etkin.\n- false: Devre dışı.

true

Http2Enabled

boolean

No

HTTP/2'nin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:\n- true (varsayılan): Etkin.\n- false: Devre dışı.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

true

SecurityPolicyId

string

No

Güvenlik politikası kimliği. Sistem güvenlik politikaları ve özel güvenlik politikaları desteklenir.\n\nVarsayılan değer: tls_cipher_policy_1_0 (sistem güvenlik politikası).\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

tls_cipher_policy_1_0

CaEnabled

boolean

No

Karşılıklı kimlik doğrulamanın etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:\n\n- true: Etkin.\n- false (varsayılan): Devre dışı.

false

XForwardedForConfig

object

No

XForward alanının yapılandırması.

XForwardedForClientCertClientVerifyAlias

string

No

Özel üst bilgi adı. Bu parametre yalnızca XForwardedForClientCertClientVerifyEnabled değeri true olarak ayarlandığında geçerli olur.\n\nDeğer 1 ila 40 karakter uzunluğunda olmalı ve a'dan z'ye küçük harfler, tire (-), alt çizgi (_) ve rakamlar içerebilir.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

test_client-verify-alias_123456

XForwardedForClientCertClientVerifyEnabled

boolean

No

Yük dengeleme örneğine erişen istemci sertifikasının doğrulama sonucunu almak için X-Forwarded-Clientcert-clientverify üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

true

XForwardedForClientCertFingerprintAlias

string

No

Özel üst bilgi adı. Bu parametre yalnızca XForwardedForClientCertFingerprintEnabled değeri true olarak ayarlandığında geçerli olur.\n\nDeğer 1 ila 40 karakter uzunluğunda olmalı ve a'dan z'ye küçük harfler, tire (-), alt çizgi (_) ve rakamlar içerebilir.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

test_finger-print-alias_123456

XForwardedForClientCertFingerprintEnabled

boolean

No

Yük dengeleme örneğine erişen istemci sertifikasının parmak izini almak için X-Forwarded-Clientcert-fingerprint üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

true

XForwardedForClientCertIssuerDNAlias

string

No

Özel üst bilgi adı. Bu parametre yalnızca XForwardedForClientCertIssuerDNEnabled değeri true olarak ayarlandığında geçerli olur.\n\nDeğer 1 ila 40 karakter uzunluğunda olmalı ve a'dan z'ye küçük harfler, tire (-), alt çizgi (_) ve rakamlar içerebilir.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

test_issue-dn-alias_123456

XForwardedForClientCertIssuerDNEnabled

boolean

No

Yük dengeleme örneğine erişen istemci sertifikasının veren bilgilerini almak için X-Forwarded-Clientcert-issuerdn üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

true

XForwardedForClientCertSubjectDNAlias

string

No

Özel üst bilgi adı. Bu parametre yalnızca XForwardedForClientCertSubjectDNEnabled değeri true olarak ayarlandığında geçerli olur.\n\nDeğer 1 ila 40 karakter uzunluğunda olmalı ve a'dan z'ye küçük harfler, tire (-), alt çizgi (_) ve rakamlar içerebilir.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

test_subject-dn-alias_123456

XForwardedForClientCertSubjectDNEnabled

boolean

No

Yük dengeleme örneğine erişen istemci sertifikasının sahip bilgilerini almak için X-Forwarded-Clientcert-subjectdn üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

true

XForwardedForClientSrcPortEnabled

boolean

No

Yük dengeleme örneğine erişen istemcinin bağlantı noktasını almak için X-Forwarded-Client-srcport üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi HTTP ve HTTPS dinleyicileri destekler.

true

XForwardedForEnabled

boolean

No

İstemcinin gerçek IP adresını almak için X-Forwarded-For üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n- true (varsayılan): Etkin.\n- false: Devre dışı.\n\n> 1. Bu parametreyi true olarak ayarlarsanız, XForwardedForProcessingMode varsayılan olarak append olur ve remove olarak değiştirilebilir.\n> 2. Bu parametreyi false olarak ayarlarsanız ALB, isteği arka uç sunucuya iletmeden önce X-Forwarded-For üst bilgisini ek bir işlem yapmadan korur.\n> 3. Bu parametreyi HTTP ve HTTPS dinleyicileri destekler.

true

XForwardedForProcessingMode

string

No

X-Forwarded-For üst bilgisini işleme modu. Bu parametre yalnızca XForwardedForEnabled değeri true olarak ayarlandığında geçerli olur. Geçerli değerler:\n- append (varsayılan): Ekle.\n- remove: Kaldır.\n\n> 1. Bu parametreyi append olarak ayarlarsanız, istek arka uç sunucuya iletilmeden önce son atlama IP adresi X-Forwarded-For üst bilgisine eklenir.\n> 2. Bu parametreyi remove olarak ayarlarsanız, isteğin X-Forwarded-For üst bilgisini içerip içermediğine bakılmaksızın istek arka uç sunucuya iletilmeden önce X-Forwarded-For üst bilgisi kaldırılır.\n> 3. Bu parametreyi HTTP ve HTTPS dinleyicileri destekler.

append

XForwardedForProtoEnabled

boolean

No

Yük dengeleme örneğinin dinleyici protokolünü almak için X-Forwarded-Proto üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi HTTP, HTTPS ve QUIC dinleyicileri destekler.

false

XForwardedForSLBIdEnabled

boolean

No

Yük dengeleme örneği kimliğini almak için SLB-ID üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi HTTP, HTTPS ve QUIC dinleyicileri destekler.

false

XForwardedForSLBPortEnabled

boolean

No

Yük dengeleme örneğinin dinleyici bağlantı noktasını almak için X-Forwarded-Port üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi HTTP, HTTPS ve QUIC dinleyicileri destekler.

false

XForwardedForClientSourceIpsEnabled

boolean

No

ALB'nin X-Forwarded-For üst bilgisinde gerçek istemci IP adresını aramasına izin verilip verilmeyeceğini belirtir. Geçerli değerler:\n\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi HTTP ve HTTPS dinleyicileri destekler.

false

XForwardedForClientSourceIpsTrusted

string

No

Güvenilen proxy IP adresları.\n\nUygulama Yük Dengeleme (ALB), X-Forwarded-For üst bilgisini sağdan sola doğru tarar ve güvenilen IP listesinde olmayan ilk IP adresını gerçek istemci IP adresı olarak seçer. Bu IP adresı, kaynak IP tabanlı hız sınırlaması için kullanılır.

10.1.1.0/24

XForwardedForHostEnabled

boolean

No

Yük dengeleme örneğine erişen istemcinin etki alanı adını almak için X-Forwarded-Host üst bilgisinin kullanılıp kullanılmayacağını belirtir. Geçerli değerler:\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi HTTP, HTTPS ve QUIC dinleyicileri destekler.

false

QuicConfig

object

No

İlişkili QUIC dinleyicisinin yapılandırması.

QuicListenerId

string

No

İlişkilendirilecek QUIC dinleyicisinin kimliği. Bu parametre HTTPS dinleyicileri için geçerlidir. Bu parametre, QuicUpgradeEnabled değeri true olarak ayarlandığında gereklidir.\n\n> Orijinal dinleyici ve ilişkili QUIC dinleyicisi aynı ALB örneğine ait olmalı ve QUIC dinleyicisi daha önce ilişkilendirilmemiş olmalıdır.

lsn-o4u54y73wq7b******

QuicUpgradeEnabled

boolean

No

QUIC yükseltmesinin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:\n- true: Etkin.\n- false (varsayılan): Devre dışı.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler.

false

Certificates

array<object>

No

Sertifika listesi bilgileri.

object

No

Sertifika yapısı.

CertificateId

string

No

Varsayılan sertifika kimliği. Yalnızca bir varsayılan sunucu sertifikası desteklenir.\n\n> - Bu parametre, ListenerProtocol değeri HTTPS veya QUIC olarak ayarlandığında gereklidir.\n> - Daha fazla sunucu sertifikası eklemek için dinleyici oluşturulduktan sonra ek sertifikaları yapılandırmak üzere AssociateAdditionalCertificatesWithListener API'sini çağırın.

103705*******

CaCertificates

array<object>

No

Dinleyici için yapılandırılan CA sertifikalarının listesi. Yalnızca bir CA sertifikası desteklenir.

object

No

Dinleyici için yapılandırılan CA sertifikası yapısı.

CertificateId

string

No

CA sertifikası kimliği.\n\n> Bu parametre, CaEnabled değeri true olarak ayarlandığında gereklidir.

123157*******

DefaultActions

array<object>

Yes

Kural eylemlerinin listesi.

array<object>

Yes

Kural eylemlerinin listesi.

ForwardGroupConfig

object

Yes

Yönlendirme eyleminin yapılandırması. En fazla 20 yönlendirme eylemi yapılandırması ekleyebilirsiniz.

ServerGroupTuples

array<object>

Yes

Yönlendirme hedefi sunucu grubu demetleri.

object

Yes

Yönlendirme hedefi sunucu grubu demetleri.

ServerGroupId

string

Yes

İsteklerin yönlendirildiği hedef sunucu grubunun kimliği.

sgp-8ilqs4axp6******

Type

string

Yes

Eylem türü. En fazla 1 eylem türü ekleyebilirsiniz.\n\nGeçerli değerler: ForwardGroup: İstekleri birden fazla sunucu grubuna yönlendirir.

ForwardGroup

Tag

array<object>

No

Etiketler.

object

No

Etiket yapısı.

Key

string

No

Etiket anahtarı. Etiket anahtarı en fazla 128 karakter uzunluğunda olabilir. aliyun veya acs: ile başlayamaz ve http:// veya https:// içeremez.

env

Value

string

No

Etiket değeri. Etiket değeri en fazla 128 karakter uzunluğunda olabilir. aliyun veya acs: ile başlayamaz ve http:// veya https:// içeremez.

product

Response elements

Element

Type

Description

Example

object

Dinleyici oluşturma yanıtı.

JobId

string

Eşzamansız görev kimliği.

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

ListenerId

string

Dinleyici kimliği.

lsn-o4u54y73wq7b******

RequestId

string

İstek kimliği.

CEF72CEB-54B6-4AE8-B225-F876*******

Examples

Success response

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "ListenerId": "lsn-o4u54y73wq7b******",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876*******"
}

Error codes

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.