DescribeLoadBalancerHTTPListenerAttribute - ENS - Centro de documentación de Alibaba Cloud

Consulta la configuración de un listener HTTP.

Descripción de la operación

Hasta 100 veces por segundo por cuenta.
Hasta 10 veces por segundo por usuario.

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

ens:DescribeLoadBalancerHTTPListenerAttribute

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ListenerPort	integer	Sí	El puerto del listener que desea consultar. Valores válidos: 1 a 65535.	80
LoadBalancerId	string	Sí	El ID de la instancia de ELB.	lb-5snthcyu1x10g7tywj7iu****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ListenerPort	integer	El puerto del listener.	80
Status	string	El estado del listener. Valores válidos: Running Stopped Starting Configuring Stopping	Running
Bandwidth	integer	El ancho de banda máximo de la instancia de Edge Load Balancer (ELB). El valor predeterminado es -1, lo que indica que el ancho de banda no está limitado.	-1
Scheduler	string	El algoritmo de enrutamiento. Valores válidos: wrr: Los servidores backend con pesos más altos reciben más solicitudes que aquellos con pesos más bajos. wlc: Las solicitudes se distribuyen según el peso y la carga de cada servidor backend. La carga se refiere al número de conexiones a un servidor backend. Si dos servidores backend tienen el mismo peso, el servidor backend que tiene menos conexiones recibe más solicitudes. rr: Las solicitudes se distribuyen a los servidores backend en secuencia. sch: Hashing consistente basado en direcciones IP de origen. Las solicitudes de la misma dirección IP de origen se distribuyen al mismo servidor backend. qch: Hashing consistente basado en ID de conexión QUIC. Las solicitudes que contienen el mismo ID de conexión QUIC se distribuyen al mismo servidor backend. iqch: Hashing consistente basado en tres bytes específicos de los CID de iQUIC. Las solicitudes cuyos bytes segundo a cuarto son iguales se distribuyen al mismo servidor backend.	wrr
HealthCheck	string	Indica si la función de comprobación de estado está habilitada. Valores válidos: on off	on
HealthyThreshold	integer	El número de comprobaciones de estado exitosas consecutivas que deben ocurrir antes de que un servidor backend inactivo e inaccesible se declare activo y accesible. Valores válidos: 2 a 10. Nota Este parámetro se devuelve solo si establece HealthCheck en on.	3
UnhealthyThreshold	integer	El número de comprobaciones de estado fallidas consecutivas que deben ocurrir antes de que un servidor backend activo y accesible se declare inactivo e inaccesible. Valores válidos: 2 a 10. Nota Este parámetro se devuelve solo si establece HealthCheck en on.	3
HealthCheckTimeout	integer	El periodo de tiempo de espera para una respuesta de comprobación de estado. Si un servidor backend no responde dentro del periodo de tiempo de espera especificado, el servidor falla la comprobación de estado. Valor predeterminado: 5. Valores válidos: 1 a 300. Unidad: segundos. Nota Este parámetro surte efecto solo si el parámetro HealthCheck se establece en on. Si el valor de HealthCheckTimeout es menor que el valor de HealthCheckInterval, el periodo de tiempo de espera especificado por HealthCheckTimeout deja de ser válido y se utiliza el valor de HealthCheckInterval como periodo de tiempo de espera.	10
HealthCheckConnectPort	integer	El puerto que se utiliza para las comprobaciones de estado. Valores válidos: 1 a 65535. Si deja este parámetro vacío, se utiliza el puerto especificado por BackendServerPort para las comprobaciones de estado. Nota Este parámetro se devuelve solo si establece HealthCheck en on.	5000
HealthCheckInterval	integer	El intervalo en el que se realizan las comprobaciones de estado. Valores válidos: 1 a 50. Unidad: segundos. Nota Este parámetro se devuelve solo si establece HealthCheck en on.	5
Description	string	La descripción del listener. La descripción debe tener una longitud de 1 a 80 caracteres. Nota El valor no puede comenzar con `http://` o `https://`.	abc
ListenerForward	string	Indica si la redirección de HTTP a HTTPS está habilitada. Valores válidos: on: La redirección de HTTP a HTTPS está habilitada. off (valor predeterminado)	off
ForwardPort	integer	El puerto del listener que se utiliza para redirigir solicitudes HTTP a HTTPS.	10002
RequestTimeout	integer	El periodo de tiempo de espera de las solicitudes. Valor predeterminado: 60. Valores válidos: 1 a 180. Unidad: segundos. Nota Si no se recibe ninguna respuesta del servidor backend dentro del periodo de tiempo de espera especificado, ELB devuelve un código de error HTTP 504 al cliente.	60
IdleTimeout	integer	El periodo de tiempo de espera para conexiones inactivas. Valor predeterminado: 15. Valores válidos: 1 a 60. Unidad: segundos. Nota Si no se recibe ninguna solicitud dentro del periodo de tiempo de espera especificado, ELB cierra la conexión. Cuando se recibe otra solicitud, ELB establece una nueva conexión.	15
HealthCheckHttpCode	string	Los códigos de estado HTTP para una comprobación de estado exitosa. Valores válidos: http_2xx (valor predeterminado) http_3xx. http_4xx http_5xx Nota Este parámetro se devuelve solo si establece HealthCheck en on.	http_2xx
HealthCheckDomain	string	El nombre de dominio que se utiliza para las comprobaciones de estado. Nota Este parámetro se devuelve solo si establece HealthCheck en on.	www.example.com
HealthCheckURI	string	La URI utilizada para las comprobaciones de estado. La URI debe tener una longitud de 1 a 80 caracteres. Nota Una URL debe comenzar con una barra diagonal (`/`) pero no puede contener únicamente barras diagonales (`/`). Este parámetro surte efecto solo si el parámetro HealthCheck se establece en on.	/checkpreload.htm
ServerCertificateId	string	El ID del certificado de servidor.	6027667
HealthCheckMethod	string	El método de comprobación de estado utilizado en las comprobaciones de estado HTTP. Valores válidos: head: Solicita el encabezado de la página. get: Solicita la parte especificada de la página y devuelve el cuerpo de la entidad. Nota Este parámetro se devuelve solo si establece HealthCheck en on.	head
XForwardedFor	string	Indica si se utiliza el encabezado X-Forwarded-For para obtener la dirección IP real del cliente. Valores válidos: on (valor predeterminado) off	on
BackendServerPort	integer	El puerto utilizado por el servidor backend de la instancia de ELB. Valores válidos: 1 a 65535.	8080

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Running",
  "Bandwidth": -1,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 3,
  "UnhealthyThreshold": 3,
  "HealthCheckTimeout": 10,
  "HealthCheckConnectPort": 5000,
  "HealthCheckInterval": 5,
  "Description": "abc",
  "ListenerForward": "off",
  "ForwardPort": 10002,
  "RequestTimeout": 60,
  "IdleTimeout": 15,
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "www.example.com",
  "HealthCheckURI": "/checkpreload.htm",
  "ServerCertificateId": "6027667",
  "HealthCheckMethod": "head",
  "XForwardedFor": "on\n",
  "BackendServerPort": 8080
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	LoadBalancerNotFound	The input parameter loadBalancerId that is not found.
400	ListenerNotFound	Listener is not found.	Listener does not exist
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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.