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

Llama a la operación DescribeLoadBalancerTCPListenerAttribute para consultar la configuración de un listener TCP.

Descripción de la operación

Tasa de llamadas a la API: 100 llamadas por segundo.
Tasa de llamadas por usuario: 10 llamadas por segundo.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

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

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ListenerPort	integer	El puerto frontend que utiliza la instancia de load balancer.	80
Status	string	El estado del listener. Valores válidos: Running: El listener está en ejecución. Stopped: El listener está detenido. Starting: El listener se está iniciando. Configuring: El listener se está configurando. Stopping: El listener se está deteniendo.	Stopped
Bandwidth	integer	El ancho de banda máximo del load balancer. El valor predeterminado es -1, que indica ancho de banda ilimitado.	-1
Scheduler	string	El algoritmo de programación. Valores válidos: wrr: Round Robin ponderado. Los servidores backend con pesos más altos reciben más solicitudes. wlc: Menos conexiones ponderado. Además de los pesos, el sistema considera el número de conexiones activas de cada servidor backend. Si varios servidores backend tienen el mismo peso, el sistema selecciona el servidor backend con menos conexiones activas. rr: Round Robin. El sistema distribuye las solicitudes secuencialmente a los servidores backend. sch: Hash de IP de origen. El sistema enruta las solicitudes de la misma dirección IP de origen al mismo servidor backend. tch: Hash de 4-tupla. El sistema enruta las solicitudes que comparten la misma 4-tupla (dirección IP de origen, dirección IP de destino, puerto de origen y puerto de destino) al mismo servidor backend.	wrr
PersistenceTimeout	integer	El tiempo de espera de persistencia de sesión. Valor predeterminado: 0. Un valor de 0 indica que la persistencia de sesión está deshabilitada. Valores válidos: 0 a 3600. Unidad: segundos.	0
EstablishedTimeout	integer	El tiempo de espera de conexión. Valores válidos: 10 a 900. Unidad: segundos.	500
HealthCheck	string	Especifica si se deben habilitar las comprobaciones de estado. Valores válidos: on: habilitar off: deshabilitar	on
HealthyThreshold	integer	El número de comprobaciones de estado exitosas consecutivas necesarias para cambiar el estado de salud de un servidor backend de `fail` (no saludable) a `success` (saludable). Valores válidos: 2 a 10. Nota Este parámetro solo surte efecto cuando el parámetro HealthCheck se establece en `on`.	4
UnhealthyThreshold	integer	El número de comprobaciones de estado fallidas consecutivas necesarias para cambiar el estado de salud de un servidor backend de `success` (saludable) a `fail` (no saludable). Valores válidos: 2 a 10. Nota Este parámetro solo surte efecto cuando el parámetro HealthCheck se establece en `on`.	4
HealthCheckConnectTimeout	integer	El tiempo de espera de respuesta para una comprobación de estado. Si una instancia ENS backend no responde dentro de este período de tiempo de espera, la comprobación de estado falla. Valor predeterminado: 5. Valores válidos: 1 a 300. Unidad: segundos. Nota Este parámetro solo surte efecto cuando el parámetro HealthCheck se establece en `on`. Si este valor es menor que el valor de `HealthCheckInterval`, se utiliza el valor de `HealthCheckInterval` como período de tiempo de espera.	100
HealthCheckInterval	integer	El intervalo entre comprobaciones de estado. Valores válidos: 1 a 50. Unidad: segundos.	5
Description	string	La descripción del listener.	ejemplo
HealthCheckHttpCode	string	Los códigos de estado HTTP que indican una comprobación de estado exitosa. Valores válidos: http_2xx (predeterminado) http_3xx http_4xx http_5xx Nota Este parámetro solo surte efecto cuando el parámetro HealthCheck se establece en `on`.	http_2xx
HealthCheckDomain	string	El nombre de dominio que se utiliza para las comprobaciones de estado. Nota Este parámetro solo surte efecto cuando el parámetro HealthCheck se establece en `on`.	example.com
HealthCheckURI	string	La URI que se utiliza para las comprobaciones de estado. Longitud: 1 a 80 caracteres. Nota La URI debe comenzar con `/` pero no puede consistir únicamente en `/`. Este parámetro solo surte efecto cuando el parámetro HealthCheck se establece en `on`.	/example/index.html
HealthCheckType	string	El tipo de comprobación de estado. Valores válidos: tcp (predeterminado) http	tcp
BackendServerPort	integer	El puerto que utilizan los servidores backend. Valores válidos: 1 a 65535.	8080
HealthCheckConnectPort	integer	El puerto que se utiliza para las comprobaciones de estado. Valores válidos: 1 a 65535. Si no se especifica este parámetro, se utiliza el valor de `BackendServerPort`. Nota Este parámetro solo surte efecto cuando el parámetro HealthCheck se establece en `on`.	8000
EipTransmit	string	Especifica si el paso directo de EIP está habilitado. Valores válidos: on: habilitar off (predeterminado): deshabilitar	on

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": -1,
  "Scheduler": "wrr",
  "PersistenceTimeout": 0,
  "EstablishedTimeout": 500,
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "example.com",
  "HealthCheckURI": "/example/index.html",
  "HealthCheckType": "tcp",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "EipTransmit": "on"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	ens.interface.error	An error occurred while call the API.
400	LoadBalancerNotFound	The input parameter loadBalancerId that is not found.
400	ListenerNotFound	Listener is not found.	Listener does not exist
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.