GetListenerAttribute - Server Load Balancer - Centro de documentación de Alibaba Cloud

Consulta los detalles de un listener.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

alb:GetListenerAttribute

get

*LoadBalancer.

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

acs:ResourceTag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ListenerId	string	Sí	El ID del listener.	lsn-o4u54y73wq7b******

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La información detallada del listener.
AclConfig	object	La estructura de configuración de ACL.
AclRelations	array<object>	Los ID de las políticas de control de acceso asociadas al listener.
	object	La estructura de las políticas de control de acceso asociadas al listener.
AclId	string	El ID de la política de control de acceso asociada al listener.	acl-doc****
Status	string	El estado de asociación entre la ACL y el listener. Valores válidos: Associating: La ACL se está asociando. Associated: La ACL está asociada. Dissociating: La ACL se está desasociando.	Associating
AclType	string	El tipo de control de acceso. Valores válidos: White: Solo se reenvían las solicitudes provenientes de las direcciones IP o bloques CIDR configurados en la ACL seleccionada. Una lista blanca es aplicable a escenarios donde una aplicación permite el acceso solo desde direcciones IP específicas. Configurar una lista blanca conlleva riesgos para el negocio. Después de configurar una lista blanca, solo las solicitudes provenientes de las direcciones IP en la lista blanca pueden acceder al listener del load balancer. Si habilita el acceso de lista blanca pero no agrega ninguna dirección IP a la ACL, el listener del load balancer reenvía todas las solicitudes. Black: No se reenvía ninguna solicitud proveniente de las direcciones IP o bloques CIDR configurados en la ACL seleccionada. Una lista negra es aplicable a escenarios donde una aplicación bloquea el acceso desde direcciones IP específicas. Si habilita el acceso de lista negra pero no agrega ninguna dirección IP a la ACL, el listener del load balancer reenvía todas las solicitudes.	White
CaCertificates	array<object>	La lista de certificados de CA.
	object
CertificateId	string	El ID del certificado de CA.	139a00*****
IsDefault	boolean	Especifica si el certificado es el certificado predeterminado. Valores válidos: true: Sí. false: No.	true
Status	string	El estado del certificado.	Associated
CaEnabled	boolean	Especifica si la autenticación mutua está habilitada. Valores válidos: true: Sí. false: No.	false
Certificates	array<object>	La lista de certificados.
	object	La estructura del certificado.
CertificateId	string	El ID del certificado. Solo se admiten certificados de servidor.	123157*******
DefaultActions	array<object>	La lista de acciones de regla predeterminadas.
	array<object>	La estructura de la acción de regla predeterminada.
ForwardGroupConfig	object	La configuración de la acción de reenvío. Este parámetro solo surte efecto cuando el tipo de acción es ForwardGroup.
ServerGroupTuples	array<object>	Los grupos de servidores de destino para el reenvío.
	object	Los grupos de servidores de destino para el reenvío.
ServerGroupId	string	El ID del grupo de servidores de destino.	sgp-i5qt20******
Type	string	El tipo de acción. Valor válido: ForwardGroup, que indica que las solicitudes se reenvían a varios grupos de servidores.	ForwardGroup
GzipEnabled	boolean	Especifica si la compresión Gzip está habilitada para comprimir tipos de archivo específicos. Valores válidos: true: Sí. false: No.	true
Http2Enabled	boolean	Especifica si HTTP/2 está habilitado. Valores válidos: true: Sí. false: No. Nota Este parámetro solo es compatible con listeners HTTPS.	true
IdleTimeout	integer	Especifica el período de tiempo de espera de conexión inactiva. Unidad: segundos. Si no se recibe ninguna solicitud dentro del período de tiempo de espera, el load balancer cierra temporalmente la conexión actual y establece una nueva conexión cuando llega la siguiente solicitud.	2
ListenerDescription	string	El nombre personalizado del listener.	HTTP_80
ListenerId	string	El ID del listener.	lsn-o4u54y73wq7b******
ListenerPort	integer	El puerto frontend utilizado por el load balancer.	80
ListenerProtocol	string	El protocolo del listener. Valores válidos: HTTP, HTTPS y QUIC.	HTTP
ListenerStatus	string	El estado actual del listener. Valores válidos: Provisioning: El listener se está creando. Running: El listener está en ejecución. Configuring: El listener se está configurando. Stopped: El listener está detenido.	Running
LoadBalancerId	string	El ID de la instancia de ALB.	alb-bd6oylbckp6k9x****
LogConfig	object	La información de configuración de registros.
AccessLogRecordCustomizedHeadersEnabled	boolean	Especifica si los campos de encabezado personalizados se incluyen en los registros de acceso. Valores válidos: true: Sí. false: No.	true
AccessLogTracingConfig	object	La información de configuración de Xtrace para los registros de acceso.
TracingEnabled	boolean	El estado de la función Xtrace. Valores válidos: true: Sí. false: No. Nota Solo puede establecer este parámetro en true cuando la función de registros de acceso (AccessLogEnabled) está habilitada para la instancia.	true
TracingSample	integer	La tasa de muestreo para Xtrace. Valores válidos: de 1 a 10000. Nota Este parámetro solo surte efecto cuando TracingEnabled se establece en true.	100
TracingType	string	El tipo de Xtrace. Valor válido: Zipkin. Nota Este parámetro solo surte efecto cuando TracingEnabled se establece en true.	Zipkin
QuicConfig	object	La información de configuración para asociar un listener QUIC.
QuicListenerId	string	El ID del listener QUIC que se va a asociar. Este parámetro es obligatorio cuando QuicUpgradeEnabled se establece en true. Este parámetro solo surte efecto para listeners HTTPS. Nota El listener original y el listener QUIC asociado deben pertenecer a la misma instancia de ALB, y el listener QUIC no debe haberse asociado previamente.	lsn-ek6ad66t****
QuicUpgradeEnabled	boolean	Especifica si la actualización de QUIC está habilitada. Valores válidos: true: Sí. false: No. Nota Este parámetro solo surte efecto para listeners HTTPS.	true
RequestId	string	El ID de la solicitud.	365F4154-92F6-4AE4-92F8-7FF******
RequestTimeout	integer	Especifica el período de tiempo de espera de la solicitud. Unidad: segundos. Si un servidor backend no envía una respuesta dentro del período de tiempo de espera, el load balancer deja de esperar y devuelve un código de error `HTTP 504` al cliente.	34
SecurityPolicyId	string	La política de seguridad. Nota Este parámetro solo es compatible con los listeners HTTPS.	tls_cipher_policy_1_1
Tags	array<object>	Las etiquetas.
	object	La estructura de la etiqueta.
Key	string	La clave de la etiqueta. Puede tener hasta 128 caracteres de longitud y no puede empezar con `aliyun` ni con `acs:`. No puede contener `http://` ni `https://`.	env
Value	string	El valor de la etiqueta. Puede tener hasta 128 caracteres de longitud y no puede empezar con `aliyun` ni con `acs:`. No puede contener `http://` ni `https://`.	product
XForwardedForConfig	object	La configuración del campo X-Forwarded-For.
XForwardedForClientCertClientVerifyAlias	string	El nombre del encabezado personalizado. Este parámetro solo surte efecto cuando XForwardedForClientCertClientVerifyEnabled se establece en true. El nombre debe tener de 1 a 40 caracteres de longitud y puede contener letras minúsculas, guiones (-), guiones bajos (_) y dígitos. Nota Este parámetro solo es compatible con los listeners HTTPS.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-Clientcert-clientverify` para obtener el resultado de la verificación del certificado de cliente que accede a la instancia de load balancer. Valores válidos: true: Sí. false: No. Nota Este parámetro solo es compatible con los listeners HTTPS.	true
XForwardedForClientCertFingerprintAlias	string	El nombre del encabezado personalizado. Este parámetro solo surte efecto cuando XForwardedForClientCertFingerprintEnabled se establece en true. El nombre debe tener de 1 a 40 caracteres de longitud y puede contener letras minúsculas, guiones (-), guiones bajos (_) y dígitos. Nota Este parámetro solo es compatible con los listeners HTTPS.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-Clientcert-fingerprint` para obtener la huella digital del certificado de cliente que accede a la instancia de load balancer. Valores válidos: true: Sí. false: No. Nota Este parámetro solo es compatible con los listeners HTTPS.	true
XForwardedForClientCertIssuerDNAlias	string	El nombre del encabezado personalizado. Este parámetro solo surte efecto cuando XForwardedForClientCertIssuerDNEnabled se establece en true. El nombre debe tener de 1 a 40 caracteres de longitud y puede contener letras minúsculas, guiones (-), guiones bajos (_) y dígitos. Nota Este parámetro solo es compatible con los listeners HTTPS.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-Clientcert-issuerdn` para obtener la información del emisor del certificado de cliente que accede a la instancia de load balancer. Valores válidos: true: Sí. false: No. Nota Este parámetro solo es compatible con los listeners HTTPS.	true
XForwardedForClientCertSubjectDNAlias	string	El nombre del encabezado personalizado. Este parámetro solo surte efecto cuando XForwardedForClientCertSubjectDNEnabled se establece en true. El nombre debe tener de 1 a 40 caracteres de longitud y puede contener letras minúsculas, guiones (-), guiones bajos (_) y dígitos. Nota Este parámetro solo es compatible con los listeners HTTPS.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-Clientcert-subjectdn` para obtener la información del sujeto del certificado de cliente que accede a la instancia de load balancer. Valores válidos: true: Sí. false: No. Nota Este parámetro solo es compatible con los listeners HTTPS.	true
XForwardedForClientSourceIpsEnabled	boolean	Especifica si se debe permitir que Application Load Balancer (ALB) obtenga la dirección IP real del cliente desde el campo de encabezado `X-Forwarded-For`. Valores válidos: true: Sí. false: No. Nota Este parámetro es compatible con los listeners HTTP y HTTPS.	false
XForwardedForClientSourceIpsTrusted	string	Las direcciones IP de proxy de confianza. Application Load Balancer (ALB) recorre el campo de encabezado `X-Forwarded-For` de atrás hacia adelante y selecciona la primera dirección IP que no está en la lista de direcciones IP de confianza como la dirección IP real del cliente. Esta dirección IP se utiliza para la limitación de tasa basada en la dirección IP de origen.	10.1.1.0/24
XForwardedForClientSrcPortEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-Client-Port` para obtener el puerto del cliente que accede a la instancia de load balancer. Valores válidos: true: Sí. false: No. Nota Este parámetro es compatible con los listeners HTTP y HTTPS.	true
XForwardedForEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-For` para obtener la dirección IP real del cliente. Valores válidos: true (predeterminado): Sí. false: No. Nota Si establece este parámetro en true, el valor predeterminado de XForwardedForProcessingMode es append, y puede cambiarlo a remove. Si establece este parámetro en false, el campo de encabezado `X-Forwarded-For` se conserva sin procesamiento adicional antes de que la solicitud se reenvíe al servidor backend. Este parámetro es compatible con los listeners HTTP y HTTPS.	true
XForwardedForHostEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-Host` para obtener el nombre de dominio del cliente que accede a la instancia de load balancer. Valores válidos: true: Sí. false (predeterminado): No. Nota Este parámetro es compatible con los listeners HTTP, HTTPS y QUIC.	false
XForwardedForProcessingMode	string	El modo de procesamiento para el campo de encabezado `X-Forwarded-For`. Este parámetro solo surte efecto cuando XForwardedForEnabled se establece en true. Valores válidos: append (predeterminado): Agrega la dirección IP del último salto al campo de encabezado `X-Forwarded-For` antes de que la solicitud se reenvíe al servidor backend. remove: Elimina el campo de encabezado `X-Forwarded-For` antes de que la solicitud se reenvíe al servidor backend, independientemente de si la solicitud contiene el campo de encabezado `X-Forwarded-For`. Nota Si establece este parámetro en append, la dirección IP del último salto se agrega al campo de encabezado `X-Forwarded-For` antes de que la solicitud se reenvíe al servidor backend. Si establece este parámetro en remove, el campo de encabezado `X-Forwarded-For` se elimina antes de que la solicitud se reenvíe al servidor backend, independientemente de si la solicitud contiene el campo de encabezado `X-Forwarded-For`. Este parámetro es compatible con los listeners HTTP y HTTPS.	append
XForwardedForProtoEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-Proto` para obtener el protocolo del listener de la instancia de load balancer. Valores válidos: true: Sí. false: No. Nota Este parámetro es compatible con los listeners HTTP, HTTPS y QUIC.	true
XForwardedForSLBIdEnabled	boolean	Especifica si se debe usar el campo de encabezado `SLB-ID` para obtener el ID de la instancia de load balancer. Valores válidos: true: Sí. false: No. Nota Este parámetro es compatible con los listeners HTTP, HTTPS y QUIC.	true
XForwardedForSLBPortEnabled	boolean	Especifica si se debe usar el campo de encabezado `X-Forwarded-Port` para obtener el puerto del listener de la instancia de load balancer. Valores válidos: true: Sí. false: No. Nota Este parámetro es compatible con los listeners HTTP, HTTPS y QUIC.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	Forbidden.LoadBalancer	Authentication is failed for %s.	La autenticación para la operación de balanceo de carga falló.
404	ResourceNotFound.Listener	The specified resource %s is not found.	El listener no existe.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.