Tüm Ürünler
Search
Belge Merkezi

:GetListenerAttribute

Son Güncelleme:Oct 09, 2026

Bir dinleyicinin ayrıntılarını sorgular.

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:GetListenerAttribute

get

*LoadBalancer.

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

  • acs:ResourceTag
None

Request parameters

Parameter

Type

Required

Description

Example

ListenerId

string

Yes

Dinleyici kimliği.

lsn-o4u54y73wq7b******

Response elements

Element

Type

Description

Example

object

Dinleyici hakkındaki ayrıntılı bilgiler.

AclConfig

object

ACL yapılandırma yapısı.

AclRelations

array<object>

Dinleyici ile ilişkilendirilmiş erişim kontrolü politikalarının kimlikleri.

object

Dinleyici ile ilişkilendirilmiş erişim kontrolü politikalarının yapısı.

AclId

string

Dinleyici ile ilişkilendirilmiş erişim kontrolü politikasının kimliği.

acl-doc****

Status

string

ACL ile dinleyici arasındaki ilişkilendirme durumu. Geçerli değerler:

  • Associating: ACL ilişkilendiriliyor.

  • Associated: ACL ilişkilendirildi.

  • Dissociating: ACL ilişkilendirmesi kaldırılıyor.

Associating

AclType

string

Erişim kontrolü türü. Geçerli değerler:

  • White: Yalnızca seçili ACL'de yapılandırılan IP adreslarından veya CIDR bloklarından gelen istekler iletilir. Beyaz liste, bir uygulamanın yalnızca belirli IP adreslarından erişime izin verdiği senaryolar için geçerlidir. Beyaz liste yapılandırmak iş riskleri doğurur. Beyaz liste yapılandırıldıktan sonra, yalnızca beyaz listedeki IP adreslarından gelen istekler yük dengeleyici dinleyicisine erişebilir. Beyaz liste erişimini etkinleştirir ancak ACL'ye herhangi bir IP adresı eklemezseniz, yük dengeleyici dinleyicisi tüm istekleri iletir.

  • Black: Seçili ACL'de yapılandırılan IP adreslarından veya CIDR bloklarından gelen hiçbir istek iletilmez. Kara liste, bir uygulamanın belirli IP adreslarından erişimi engellediği senaryolar için geçerlidir. Kara liste erişimini etkinleştirir ancak ACL'ye herhangi bir IP adresı eklemezseniz, yük dengeleyici dinleyicisi tüm istekleri iletir.

White

CaCertificates

array<object>

CA sertifikalarının listesi.

object

CertificateId

string

CA sertifikasının kimliği.

139a00*****

IsDefault

boolean

Sertifikanın varsayılan sertifika olup olmadığını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

true

Status

string

Sertifikanın durumu.

Associated

CaEnabled

boolean

Karşılıklı kimlik doğrulamanın etkin olup olmadığını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

false

Certificates

array<object>

Sertifikaların listesi.

object

Sertifika yapısı.

CertificateId

string

Sertifikanın kimliği. Yalnızca sunucu sertifikaları desteklenir.

123157*******

DefaultActions

array<object>

Varsayılan kural eylemlerinin listesi.

array<object>

Varsayılan kural eyleminin yapısı.

ForwardGroupConfig

object

İletme eyleminin yapılandırması. Bu parametre yalnızca eylem türü ForwardGroup olduğunda geçerli olur.

ServerGroupTuples

array<object>

İletim için hedef sunucu grupları.

object

İletim için hedef sunucu grupları.

ServerGroupId

string

Hedef sunucu grubunun kimliği.

sgp-i5qt20******

Type

string

Eylem türü. Geçerli değer: İsteklerin birden fazla sunucu grubuna iletildiğini belirten ForwardGroup.

ForwardGroup

GzipEnabled

boolean

Belirli dosya türlerini sıkıştırmak için Gzip sıkıştırmasının etkin olup olmadığını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

true

Http2Enabled

boolean

HTTP/2'nin etkin olup olmadığını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

true

IdleTimeout

integer

Boşta bağlantı zaman aşımı süresini belirtir. Birim: saniye.

Zaman aşımı süresi içinde hiçbir istek alınmazsa, yük dengeleyici mevcut bağlantıyı geçici olarak kapatır ve bir sonraki istek geldiğinde yeni bir bağlantı kurar.

2

ListenerDescription

string

Dinleyicinin özel adı.

HTTP_80

ListenerId

string

Dinleyici kimliği.

lsn-o4u54y73wq7b******

ListenerPort

integer

Yük dengeleyici tarafından kullanılan ön uç bağlantı noktası.

80

ListenerProtocol

string

Dinleyici protokolü. Geçerli değerler: HTTP, HTTPS ve QUIC.

HTTP

ListenerStatus

string

Dinleyicinin mevcut durumu. Geçerli değerler:

  • Provisioning: Dinleyici oluşturuluyor.

  • Running: Dinleyici çalışıyor.

  • Configuring: Dinleyici yapılandırılıyor.

  • Stopped: Dinleyici durduruldu.

Running

LoadBalancerId

string

ALB örneğinin kimliği.

alb-bd6oylbckp6k9x****

LogConfig

object

Günlük yapılandırma bilgileri.

AccessLogRecordCustomizedHeadersEnabled

boolean

Erişim günlüklerine özel üst bilgi alanlarının dahil edilip edilmediğini belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

true

AccessLogTracingConfig

object

Erişim günlükleri için Xtrace yapılandırma bilgileri.

TracingEnabled

boolean

Xtrace özelliğinin durumu. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametreyi yalnızca örnek için erişim günlüğü özelliği (AccessLogEnabled) etkinleştirildiğinde true olarak ayarlayabilirsiniz.

true

TracingSample

integer

Xtrace için örnekleme oranı. Geçerli değerler: 1 ile 10000 arası.

Not

Bu parametre yalnızca TracingEnabled değeri true olarak ayarlandığında geçerli olur.

100

TracingType

string

Xtrace türü. Geçerli değer: Zipkin.

Not

Bu parametre yalnızca TracingEnabled değeri true olarak ayarlandığında geçerli olur.

Zipkin

QuicConfig

object

Bir QUIC dinleyicisini ilişkilendirmek için yapılandırma bilgileri.

QuicListenerId

string

İlişkilendirilecek QUIC dinleyicisinin kimliği. Bu parametre, QuicUpgradeEnabled değeri true olarak ayarlandığında gereklidir. Bu parametre yalnızca HTTPS dinleyicileri için geçerli olur.

Not

Orijinal dinleyici ve ilişkilendirilen QUIC dinleyicisi aynı ALB örneğine ait olmalıdır ve QUIC dinleyicisi daha önce ilişkilendirilmemiş olmalıdır.

lsn-ek6ad66t****

QuicUpgradeEnabled

boolean

QUIC yükseltmesinin etkin olup olmadığını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre yalnızca HTTPS dinleyicileri için geçerli olur.

true

RequestId

string

İstek kimliği.

365F4154-92F6-4AE4-92F8-7FF******

RequestTimeout

integer

İstek zaman aşımı süresini belirtir. Birim: saniye.

Bir arka uç sunucusu zaman aşımı süresi içinde yanıt göndermezse, yük dengeleyici beklemeyi durdurur ve istemciye bir HTTP 504 hata kodu döndürür.

34

SecurityPolicyId

string

Güvenlik ilkesi.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

tls_cipher_policy_1_1

Tags

array<object>

Etiketler.

object

Etiket yapısı.

Key

string

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

env

Value

string

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

product

XForwardedForConfig

object

X-Forwarded-For alanı yapılandırması.

XForwardedForClientCertClientVerifyAlias

string

Özel üst bilgi adı. Bu parametre yalnızca XForwardedForClientCertClientVerifyEnabled true olarak ayarlandığında geçerli olur. Ad 1 ila 40 karakter uzunluğunda olmalı ve küçük harf, tire (-), alt çizgi (_) ve rakam içerebilir.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

test_client-verify-alias_123456

XForwardedForClientCertClientVerifyEnabled

boolean

Yük dengeleme örneğine erişen istemci sertifikasının doğrulama sonucunu almak için X-Forwarded-Clientcert-clientverify üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

true

XForwardedForClientCertFingerprintAlias

string

Özel üst bilgi adı. Bu parametre yalnızca XForwardedForClientCertFingerprintEnabled true olarak ayarlandığında geçerli olur. Ad 1 ila 40 karakter uzunluğunda olmalı ve küçük harf, tire (-), alt çizgi (_) ve rakam içerebilir.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

test_finger-print-alias_123456

XForwardedForClientCertFingerprintEnabled

boolean

Yük dengeleme örneğine erişen istemci sertifikasının parmak izini almak için X-Forwarded-Clientcert-fingerprint üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

true

XForwardedForClientCertIssuerDNAlias

string

Özel üst bilgi adı. Bu parametre yalnızca XForwardedForClientCertIssuerDNEnabled true olarak ayarlandığında geçerli olur. Ad 1 ila 40 karakter uzunluğunda olmalı ve küçük harf, tire (-), alt çizgi (_) ve rakam içerebilir.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

test_issue-dn-alias_123456

XForwardedForClientCertIssuerDNEnabled

boolean

Yük dengeleme örneğine erişen istemci sertifikasının veren bilgilerini almak için X-Forwarded-Clientcert-issuerdn üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

true

XForwardedForClientCertSubjectDNAlias

string

Özel üst bilgi adı. Bu parametre yalnızca XForwardedForClientCertSubjectDNEnabled true olarak ayarlandığında geçerli olur. Ad 1 ila 40 karakter uzunluğunda olmalı ve küçük harf, tire (-), alt çizgi (_) ve rakam içerebilir.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

test_subject-dn-alias_123456

XForwardedForClientCertSubjectDNEnabled

boolean

Yük dengeleme örneğine erişen istemci sertifikasının konu bilgilerini almak için X-Forwarded-Clientcert-subjectdn üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre yalnızca HTTPS dinleyicileri tarafından desteklenir.

true

XForwardedForClientSourceIpsEnabled

boolean

Uygulama Yük Dengeleyicisinin (ALB), gerçek istemci IP adresini X-Forwarded-For üst bilgi alanından almasına izin verilip verilmeyeceğini belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre HTTP ve HTTPS dinleyicileri tarafından desteklenir.

false

XForwardedForClientSourceIpsTrusted

string

Güvenilen ara sunucu IP adresları.

Uygulama Yük Dengeleme (ALB), X-Forwarded-For üst bilgi alanını sondan başa doğru tarar ve güvenilen IP adresi listesinde olmayan ilk IP adresini gerçek istemci IP adresi olarak seçer. Bu IP adresi, kaynak IP adresi tabanlı hız sınırlaması için kullanılır.

10.1.1.0/24

XForwardedForClientSrcPortEnabled

boolean

Yük dengeleme örneğine erişen istemcinin bağlantı noktasını almak için X-Forwarded-Client-Port üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre HTTP ve HTTPS dinleyicileri tarafından desteklenir.

true

XForwardedForEnabled

boolean

İstemcinin gerçek IP adresini almak için X-Forwarded-For üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true (varsayılan): Evet.

  • false: Hayır.

Not
  1. Bu parametreyi true olarak ayarlarsanız, XForwardedForProcessingMode parametresinin varsayılan değeri append olur ve bunu remove olarak değiştirebilirsiniz.

  2. Bu parametreyi false olarak ayarlarsanız, istek arka uç sunucuya iletilmeden önce X-Forwarded-For üst bilgi alanı ek bir işlem yapılmadan korunur.

  3. Bu parametre HTTP ve HTTPS dinleyicileri tarafından desteklenir.

true

XForwardedForHostEnabled

boolean

Yük dengeleme örneğine erişen istemcinin etki alanı adını almak için X-Forwarded-Host üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false (varsayılan): Hayır.

Not

Bu parametre HTTP, HTTPS ve QUIC dinleyicileri tarafından desteklenir.

false

XForwardedForProcessingMode

string

X-Forwarded-For üst bilgi alanı için işleme modu. Bu parametre yalnızca XForwardedForEnabled true olarak ayarlandığında geçerli olur. Geçerli değerler:

  • append (varsayılan): İstek arka uç sunucuya iletilmeden önce son sıçramanın IP adresini X-Forwarded-For üst bilgi alanına ekler.

  • remove: İsteğin X-Forwarded-For üst bilgi alanını içerip içermediğine bakılmaksızın, istek arka uç sunucuya iletilmeden önce X-Forwarded-For üst bilgi alanını siler.

Not
  1. Bu parametreyi append olarak ayarlarsanız, istek arka uç sunucuya iletilmeden önce son sıçramanın IP adresi X-Forwarded-For üst bilgi alanına eklenir.

  2. Bu parametreyi remove olarak ayarlarsanız, isteğin X-Forwarded-For üst bilgi alanını içerip içermediğine bakılmaksızın, istek arka uç sunucuya iletilmeden önce X-Forwarded-For üst bilgi alanı silinir.

  3. Bu parametre HTTP ve HTTPS dinleyicileri tarafından desteklenir.

append

XForwardedForProtoEnabled

boolean

Yük dengeleme örneğinin dinleyici protokolünü almak için X-Forwarded-Proto üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre HTTP, HTTPS ve QUIC dinleyicileri tarafından desteklenir.

true

XForwardedForSLBIdEnabled

boolean

Yük dengeleme örnek kimliğini almak için SLB-ID üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre HTTP, HTTPS ve QUIC dinleyicileri tarafından desteklenir.

true

XForwardedForSLBPortEnabled

boolean

Yük dengeleme örneğinin dinleyici bağlantı noktasını almak için X-Forwarded-Port üst bilgi alanının kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

  • true: Evet.

  • false: Hayır.

Not

Bu parametre HTTP, HTTPS ve QUIC dinleyicileri tarafından desteklenir.

true

Examples

Success response

JSON format

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "CaCertificates": [
    {
      "CertificateId": "139a00*****",
      "IsDefault": true,
      "Status": "Associated"
    }
  ],
  "CaEnabled": false,
  "Certificates": [
    {
      "CertificateId": "123157*******"
    }
  ],
  "DefaultActions": [
    {
      "ForwardGroupConfig": {
        "ServerGroupTuples": [
          {
            "ServerGroupId": "sgp-i5qt20******"
          }
        ]
      },
      "Type": "ForwardGroup"
    }
  ],
  "GzipEnabled": true,
  "Http2Enabled": true,
  "IdleTimeout": 2,
  "ListenerDescription": "HTTP_80",
  "ListenerId": "lsn-o4u54y73wq7b******",
  "ListenerPort": 80,
  "ListenerProtocol": "HTTP",
  "ListenerStatus": "Running",
  "LoadBalancerId": "alb-bd6oylbckp6k9x****",
  "LogConfig": {
    "AccessLogRecordCustomizedHeadersEnabled": true,
    "AccessLogTracingConfig": {
      "TracingEnabled": true,
      "TracingSample": 100,
      "TracingType": "Zipkin"
    }
  },
  "QuicConfig": {
    "QuicListenerId": "lsn-ek6ad66t****",
    "QuicUpgradeEnabled": true
  },
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "RequestTimeout": 34,
  "SecurityPolicyId": "tls_cipher_policy_1_1",
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ],
  "XForwardedForConfig": {
    "XForwardedForClientCertClientVerifyAlias": "test_client-verify-alias_123456",
    "XForwardedForClientCertClientVerifyEnabled": true,
    "XForwardedForClientCertFingerprintAlias": "test_finger-print-alias_123456",
    "XForwardedForClientCertFingerprintEnabled": true,
    "XForwardedForClientCertIssuerDNAlias": "test_issue-dn-alias_123456",
    "XForwardedForClientCertIssuerDNEnabled": true,
    "XForwardedForClientCertSubjectDNAlias": "test_subject-dn-alias_123456",
    "XForwardedForClientCertSubjectDNEnabled": true,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24",
    "XForwardedForClientSrcPortEnabled": true,
    "XForwardedForEnabled": true,
    "XForwardedForHostEnabled": false,
    "XForwardedForProcessingMode": "append",
    "XForwardedForProtoEnabled": true,
    "XForwardedForSLBIdEnabled": true,
    "XForwardedForSLBPortEnabled": true
  }
}

Error codes

HTTP status code

Error code

Error message

Description

403 Forbidden.LoadBalancer Authentication is failed for %s. Yük dengeleme işlemi için kimlik doğrulama başarısız oldu.
404 ResourceNotFound.Listener The specified resource %s is not found. Dinleyici mevcut değildir.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.