Bir dinleyicinin adı ve varsayılan eylemi gibi yapılandırma özelliklerini günceller.
Operation description
UpdateListenerAttribute eşzamanlı olmayan bir işlemdir. Bir istek kimliği döndürüldükten sonra, dinleyici yapılandırma güncellemesi arka planda işlenmeye devam eder. Dinleyici yapılandırmasının güncelleme durumunu sorgulamak için GetListenerAttribute çağrısı yapabilirsiniz:\n- Dinleyici Configuring durumundaysa, dinleyici yapılandırması güncelleniyor demektir.\n- Dinleyici Running durumundaysa, dinleyici yapılandırması güncellenmiş demektir.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
alb:UpdateListenerAttribute |
update |
*LoadBalancer
*SecurityPolicy
*ServerGroup
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ListenerId |
string |
Yes |
Uygulama Yük Dengeleme (ALB) örneğinin dinleyici kimliği. |
lsn-o4u54y73wq7b****** |
| ClientToken |
string |
No |
İsteğin yinelenmezliğ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 otomatik olarak RequestId değerini ClientToken olarak kullanır. RequestId her API isteği için farklı olabilir. |
5A2CFF0E-5718-45B5-9D4D-70B****** |
| 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 dahil olmak üzere istekteki olası sorunları 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 |
false |
| ListenerDescription |
string |
No |
Özel dinleyici adı.\n\nAd 2 ila 256 karakter uzunluğunda olmalıdır; harf, rakam, Çince karakter, virgül (,), nokta (.), noktalı virgül (;), eğik çizgi (/), @ işareti, alt çizgi (_) ve tire (-) içerebilir. |
HTTP_80 |
| RequestTimeout |
integer |
No |
İstek zaman aşımı süresi. Birim: saniye. Geçerli değerler: 1 ile 600.\n\nZaman aşımı süresi içinde arka uç sunucudan yanıt alınamazsa, yük dengeleyici istemciye bir |
60 |
| IdleTimeout |
integer |
No |
Boşta bağlantı zaman aşımı süresi. Birim: saniye. Geçerli değerler: 1 ile 600.\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 ve bir sonraki istek geldiğinde bağlantıyı geri yükler. |
15 |
| 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: etkin.\n- false: devre dışı. |
true |
| Http2Enabled |
boolean |
No |
HTTP/2'nin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:\n- true: etkin.\n- false: devre dışı.\n\n> Bu parametreyi yalnızca HTTPS dinleyicileri destekler. |
true |
| SecurityPolicyId |
string |
No |
Güvenlik politikası. Sistem güvenlik politikaları ve özel güvenlik politikaları desteklenir.\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- true: etkin.\n- false: devre dışı. |
false |
| XForwardedForConfig |
object |
No |
XForwardedFor özelliğinin yapılandırması. |
|
| XForwardedForClientCertClientVerifyAlias |
string |
No |
Özel üst bilgi alanı adı. Bu parametre yalnızca XForwardedForClientCertClientVerifyEnabled değeri true olarak ayarlandığında geçerli olur.\n\nAd 1 ila 40 karakter uzunluğunda olmalıdır; 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 |
false |
| XForwardedForClientCertFingerprintAlias |
string |
No |
Özel üst bilgi alanı adı. Bu parametre yalnızca XForwardedForClientCertFingerprintEnabled değeri true olarak ayarlandığında geçerli olur.\n\nAd 1 ila 40 karakter uzunluğunda olmalıdır; 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 |
false |
| XForwardedForClientCertIssuerDNAlias |
string |
No |
Özel üst bilgi alanı adı. Bu parametre yalnızca XForwardedForClientCertIssuerDNEnabled değeri true olarak ayarlandığında geçerli olur.\n\nAd 1 ila 40 karakter uzunluğunda olmalıdır; 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 |
false |
| XForwardedForClientCertSubjectDNAlias |
string |
No |
Özel üst bilgi alanı adı. Bu parametre yalnızca XForwardedForClientCertSubjectDNEnabled değeri true olarak ayarlandığında geçerli olur.\n\nAd 1 ila 40 karakter uzunluğunda olmalıdır; 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 |
false |
| XForwardedForClientSrcPortEnabled |
boolean |
No |
Yük dengeleme örneğine erişen istemcinin bağlantı noktasını almak için |
false |
| XForwardedForEnabled |
boolean |
No |
İstemcinin gerçek IP adresını almak için |
true |
| XForwardedForProcessingMode |
string |
No |
|
append |
| XForwardedForProtoEnabled |
boolean |
No |
Yük dengeleme örneğinin dinleyici protokolünü almak için |
false |
| XForwardedForSLBIdEnabled |
boolean |
No |
Yük dengeleme örnek kimliğini almak için |
false |
| XForwardedForSLBPortEnabled |
boolean |
No |
Yük dengeleme örneğinin dinleyici bağlantı noktasını almak için |
false |
| XForwardedForClientSourceIpsEnabled |
boolean |
No |
ALB'nin gerçek istemci IP adresını X-Forwarded-For üst bilgi alanından almasına izin verilip verilmeyeceğini belirtir. Geçerli değerler:\n\n- true: etkin.\n- false: 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), |
10.1.1.0/24 |
| XForwardedForHostEnabled |
boolean |
No |
Yük dengeleme örneğine erişen istemcinin etki alanı adını almak için |
false |
| QuicConfig |
object |
No |
İlişkili bir QUIC dinleyicisi etkinleştirildiğindeki yapılandırma bilgileri. |
|
| QuicListenerId |
string |
No |
İ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çerlidir.\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-333 |
| QuicUpgradeEnabled |
boolean |
No |
QUIC yükseltmesinin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:\n- true: etkin.\n- false: devre dışı.\n\n> Bu parametre yalnızca HTTPS dinleyicileri için geçerlidir. |
false |
| Certificates |
array<object> |
No |
Sertifika listesi. |
|
|
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, dinleyici protokolü türü HTTPS veya QUIC olduğunda gereklidir.\n> - Daha fazla sunucu sertifikası eklemek için, dinleyici oluşturulduktan sonra uzantı sertifikalarını yapılandırmak üzere AssociateAdditionalCertificatesWithListener çağrısı yapın. |
123157****** |
| CaCertificates |
array<object> |
No |
CA sertifikası listesi. Yalnızca bir CA sertifikası desteklenir. |
|
|
object |
No |
CA sertifikası yapısı. |
||
| CertificateId |
string |
No |
CA sertifikası kimliği.\n\n> Bu parametre, CaEnabled değeri true olarak ayarlandığında gereklidir. |
123359****** |
| DefaultActions |
array<object> |
No |
Varsayılan kural eylemlerinin listesi. |
|
|
array<object> |
No |
Varsayılan kural eylemi yapısı. |
||
| ForwardGroupConfig |
object |
No |
Eylem için yönlendirme yapılandırması. Bu parametre yalnızca Type değeri ForwardGroup olarak ayarlandığında gereklidir ve geçerlidir. En fazla 20 yönlendirme eylemi yapılandırması ekleyebilirsiniz. |
|
| ServerGroupTuples |
array<object> |
Yes |
Yönlendirme hedefi sunucu grubu demetlerinin listesi. |
|
|
object |
No |
Yönlendirme hedefi sunucu grubu demeti yapısı. |
||
| ServerGroupId |
string |
Yes |
İsteklerin yönlendirildiği hedef sunucu grubunun kimliği. |
sgp-i5qt20****** |
| Type |
string |
Yes |
Eylem türü. En fazla bir eylem türü ekleyebilirsiniz. Geçerli değerler: İsteklerin birden fazla sunucu grubuna yönlendirildiğini belirten ForwardGroup. |
ForwardGroup |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Yanıt yapısı. |
||
| JobId |
string |
Eşzamansız görev kimliği. |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| RequestId |
string |
İstek kimliği. |
365F4154-92F6-4AE4-92F8-7FF****** |
Examples
Success response
JSON format
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF******"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | |
| 400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | |
| 400 | IncorrectStatus.Listener | The status of %s [%s] is incorrect. | |
| 400 | OperationDenied.CrossLoadBalancerQUICListener | The operation is not allowed because of %s. | |
| 400 | ResourceAlreadyAssociated.Listener | The specified resource %s is already associated. | |
| 400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | |
| 400 | ResourceAlreadyAssociated.Certificate | 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 | OperationDenied.ServerGroupProtocolNotSupport | The operation is not allowed because of ServerGroupProtocolNotSupport. | |
| 400 | UnsupportedFeature.FullTraceHttps | The feature of FullTraceHttps is not supported for current instance. | |
| 400 | ResourceInConfiguring.Listener | The specified resource of %s is being configured, please try again later. | |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | |
| 400 | InvalidParameter | Invalid parameter, please check the parameter input. | |
| 400 | OperationDenied.CACertificateCorrupted | The CA certificate is corrupted. | |
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. | |
| 404 | ResourceNotFound.Listener | 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.Certificate | The specified resource %s is not found. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.