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

Crea un listener TCP.

Descripción de la operación

Nota

El listener recién creado se encuentra en el estado stopped. Una vez creado el listener, invoque la operación StartLoadBalancerListener para iniciarlo y reenviar el tráfico.

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

slb:CreateLoadBalancerTCPListener

create

AccessControlList.

acs:slb:{#regionId}:{#accountId}:acl/{#AclId}

*LoadBalancer.

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

slb:tag
slb:tag
slb:tag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	No	El ID de la región de la instancia de Classic Load Balancer (CLB). Puede consultar el ID de la región en la lista de Regiones y zonas o invocando la operación DescribeRegions.	cn-hangzhou
LoadBalancerId	string	Sí	El ID de la instancia de CLB.	lb-bp1b6c719dfa08ex****
ListenerPort	integer	Sí	El puerto frontend que utiliza la instancia de CLB. Valores válidos: 1 a 65535.	80
BackendServerPort	integer	No	El puerto backend que utiliza la instancia de CLB. Valores válidos: 1 a 65535. Este parámetro es obligatorio si no utiliza un grupo de servidores (no especifica vServerGroupId).	80
Tag	array<object>	No	Las etiquetas.
	object	No	Las etiquetas.
Key	string	No	La clave de etiqueta del listener. Valores válidos de N: 1 a 20. La clave de etiqueta no puede ser una cadena vacía. La clave de etiqueta puede tener hasta 64 caracteres de longitud y no puede empezar con `aliyun` ni con `acs:`. La clave de etiqueta no puede contener `http://` ni `https://`.	TestKey
Value	string	No	El valor de etiqueta del listener. Valores válidos de N: 1 a 20. El valor de etiqueta puede ser una cadena vacía. El valor de etiqueta puede tener hasta 128 caracteres de longitud y no puede empezar con `acs:`. El valor de etiqueta no puede contener `http://` ni `https://`.	TestValue
Bandwidth	integer	Sí	El ancho de banda máximo del listener. Unidad: Mbit/s. Valores válidos: -1: Para una instancia de SLB orientada a Internet con pago por transferencia de datos, puede establecer el ancho de banda máximo en -1, lo que especifica un ancho de banda ilimitado. 1 a 5120: Para una instancia de SLB orientada a Internet con pago por ancho de banda, puede establecer el ancho de banda máximo para cada listener. La suma de los valores de ancho de banda máximo de todos los listeners no puede superar el ancho de banda máximo de la instancia.	-1
Scheduler	string	No	El algoritmo de programación. Valores válidos: wrr (valor predeterminado): Los servidores backend con mayores pesos reciben más solicitudes mediante sondeo. rr: Las solicitudes se distribuyen a los servidores backend en secuencia de acceso. 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. tch: Hashing consistente basado en los siguientes parámetros: dirección IP de origen, dirección IP de destino, puerto de origen y puerto de destino. Las solicitudes que contienen la misma información basada en los cuatro factores se distribuyen al mismo servidor backend. Nota Solo las instancias de alto rendimiento admiten los algoritmos de hashing consistente sch y tch.	wrr
PersistenceTimeout	integer	No	El tiempo de espera de la persistencia de sesión. Unidad: segundos. Valores válidos: 0 a 3600. Valor predeterminado: 0, que indica que la persistencia de sesión está deshabilitada.	0
EstablishedTimeout	integer	No	El tiempo de espera de conexión. Unidad: segundos. Valores válidos: 10 a 900.	500
HealthyThreshold	integer	No	El número de comprobaciones de estado correctas consecutivas que deben producirse antes de que un servidor backend se declare en buen estado. El estado de la comprobación de estado del servidor backend cambia de fail a success. Valores válidos: 2 a 10.	4
UnhealthyThreshold	integer	No	El número de comprobaciones de estado fallidas consecutivas que deben producirse antes de que un servidor backend se declare en mal estado. El estado de la comprobación de estado del servidor backend cambia de success a fail. Valores válidos: 2 a 10.	4
HealthCheckConnectTimeout	integer	No	El tiempo de espera máximo para cada respuesta de comprobación de estado. Unidad: segundos. Valores válidos: 1 a 300. Valor predeterminado: 5.	100
HealthCheckConnectPort	integer	No	El puerto utilizado para las comprobaciones de estado. Valores válidos: 1 a 65535. Si no se establece este parámetro, se utiliza el puerto de servicio backend (BackendServerPort) para las comprobaciones de estado.	80
healthCheckInterval	integer	No	El intervalo entre dos comprobaciones de estado consecutivas. Unidad: segundos. Valores válidos: 1 a 50.	3
HealthCheckDomain	string	No	El nombre de dominio utilizado para las comprobaciones de estado. Valores válidos: $_ip: la dirección IP privada del servidor backend. Si especifica $_ip o no especifica este parámetro, Server Load Balancer utiliza la dirección IP de red privada de cada servidor backend como nombre de dominio para las comprobaciones de estado. domain: El nombre de dominio debe tener de 1 a 80 caracteres de longitud y solo puede contener letras, dígitos, puntos (.) y guiones (-).	172.XX.XX.6
HealthCheckURI	string	No	El URI utilizado para las comprobaciones de estado. El URI debe tener de 1 a 80 caracteres de longitud y solo puede contener letras, dígitos, guiones (-), barras diagonales (/), puntos (.), signos de porcentaje (%), signos de número (#) y ampersands (&). El URI no puede ser solo una barra diagonal (/), sino que debe comenzar con una barra diagonal (/). Puede configurar este parámetro cuando el listener TCP requiere comprobaciones de estado HTTP. Si no se configura este parámetro, se realizan comprobaciones de estado TCP.	/test/index.html
HealthCheckHttpCode	string	No	El código de estado HTTP que indica un resultado de comprobación de estado normal. Separe varios códigos de estado HTTP con comas (,). Valores válidos: http_2xx (valor predeterminado) http_3xx http_4xx http_5xx	http_2xx,http_3xx
HealthCheckType	string	No	El tipo de comprobación de estado. Valores válidos: tcp (valor predeterminado) http	tcp
VServerGroupId	string	No	El ID del grupo vServer.	rsp-cige6j****
MasterSlaveServerGroupId	string	No	El ID del grupo de servidores principal/secundario. Nota Solo puede especificar uno de estos: el ID del grupo vServer o el ID del grupo de servidores principal/secundario.	rsp-0bfucw****
AclId	string	No	El ID de la lista de control de acceso (ACL) vinculada al listener. Nota Este parámetro es obligatorio cuando el parámetro AclStatus se establece en on.	acl-uf60jwfiv6******
AclType	string	No	El tipo de control de acceso. Valores válidos: white: Solo se reenvían las solicitudes de las direcciones IP o bloques CIDR en el grupo de políticas de control de acceso seleccionado. Las listas blancas son aplicables a escenarios en los que desea permitir que solo direcciones IP específicas accedan a su servicio. Configurar una lista blanca conlleva riesgos para sus cargas de trabajo. Una vez configurada la lista blanca, solo las direcciones IP en la lista blanca pueden acceder al listener de SLB. Si se habilita una lista blanca pero no se agrega ninguna dirección IP al grupo de políticas de control de acceso, el listener de SLB reenvía todas las solicitudes. black: Se deniegan todas las solicitudes de las direcciones IP o bloques CIDR en el grupo de políticas de control de acceso seleccionado. Las listas negras son aplicables a escenarios en los que desea denegar el acceso desde direcciones IP específicas. Si se habilita una lista negra pero no se agrega ninguna dirección IP al grupo de políticas de control de acceso, el listener de SLB reenvía todas las solicitudes. Nota Este parámetro solo surte efecto cuando el parámetro AclStatus se establece en on.	black
AclStatus	string	No	Especifica si se debe habilitar el control de acceso. Valores válidos: on: habilitado. off (valor predeterminado): deshabilitado.	off
Description	string	No	El nombre personalizado del listener. El nombre debe tener de 1 a 256 caracteres de longitud y puede contener caracteres chinos, letras, dígitos, guiones (-), barras diagonales (/), puntos (.) y guiones bajos (_).	tcp_80
ConnectionDrain	string	No	Especifica si se debe habilitar el drenaje de conexiones. Valores válidos: on: habilitado. off: deshabilitado.	off
ConnectionDrainTimeout	integer	No	El tiempo de espera del drenaje de conexiones. Unidad: segundos. Valores válidos: 10 a 900. Nota Este parámetro es obligatorio cuando ConnectionDrain se establece en on.	300
ProxyProtocolV2Enabled	boolean	No	Especifica si se debe usar Proxy Protocol para pasar la dirección de origen del cliente al servidor backend. Valores válidos: true: habilitado. false (valor predeterminado): deshabilitado.	false
HealthCheckSwitch	string	No	Especifica si se deben habilitar las comprobaciones de estado. Valores válidos: on (valor predeterminado): habilitado. off: deshabilitado.	on

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidParameterValue.SpecNotSupport	The loadBalancer of shared spec does not support the parameter value, %s.	El valor del parámetro especificado no es compatible con las instancias de SLB de recursos compartidos.
400	OperationNotSupport.Acl	The cloud box instance does not support acl.	Las instancias de CloudBox no admiten la configuración de control de acceso.
400	InvalidParameterValue.RegionNotSupport	The region does not support the parameter value, %s.	El valor del parámetro especificado no se admite en la región actual.
400	Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch	The parameters VServerGroupId or MasterSlaveServerGroupId miss match.
400	IpVersionConflict	The ip version of this LoadBalancer and the Acl is conflict.	La versión de IP de la instancia de Server Load Balancer especificada entra en conflicto con el tipo de IP que admite la ACL.
400	InvalidParameterValue.ZoneNotSupport	The zone does not support the parameter value, %s.	El valor del parámetro especificado no se admite en la zona actual.
400	ListenerProcessing	A previous configuration of the listener is pending, please try again later.	El listener actual se está configurando. Inténtelo de nuevo más tarde.
400	AclNotExist	Acl does not exist.	La ACL especificada no existe.
400	InvalidParameter.ListenerPortConflict	There is conflict listener port exists.	El puerto de escucha especificado ya existe.
400	InvalidParameter.ZoneNotSupport	The zone does not support the parameter %s.	El parámetro especificado no se admite en la zona actual.
400	InvalidParam.VServerGroupId	The specified VServerGroupId is invalid.	El VServerGroupId especificado no es válido. Verifique las restricciones del parámetro e inténtelo de nuevo.
400	MissingParam.HealthCheckConnectPort	The parameter HealthCheckConnectPort is required.	Falta el parámetro HealthCheckConnectPort.
400	InvalidParam.ListenerPort	The specified ListenerPort is invalid.	El ListenerPort especificado no es válido. Verifique las restricciones del parámetro e inténtelo de nuevo después de modificarlo.
400	InvalidParam.StartPort	The specified StartPort is invalid.	El StartPort especificado no es válido. Verifique las restricciones del parámetro e inténtelo de nuevo.
400	InvalidParamSize.PortRange	The size of param PortRange is invalid.	El PortRange especificado no es válido. Verifique las restricciones del parámetro e inténtelo de nuevo después de modificarlo.
400	InvalidParam.EndPort	The specified EndPort is invalid.	El EndPort especificado no es válido. Verifique las restricciones del parámetro e inténtelo de nuevo después de modificarlo.
400	Duplicated.AclEntry	%s.	%s
400	OperationUnsupported.SetAccessControl	The singleTunnel/anyTunnel loadbalancer does not support config AccessControlList.	La operación se deniega porque las instancias de SLB SingleTunnel y AnyTunnel no admiten la configuración de ACL.
400	InvalidParam.PortRange	The specified PortRange is invalid.	El PortRange especificado no es válido. Verifique las restricciones del parámetro e inténtelo de nuevo después de modificarlo.
400	InvalidParameter.RegionNotSupport	The region does not support the parameter: %s.	El parámetro especificado no se admite en la región actual.
400	LbNotSupportTcpssl	You cannot create a TCP SSL type listener for the specified load balancer.	La instancia especificada no admite crear listeners de tipo TCP/SSL.
400	LbSupportTcpsslOnly	The specified load balancer supports TCP SSL type listener only.	La instancia especificada solo admite crear listeners de tipo TCP/SSL.
400	ListenerNotSupportRule	You cannot create a rule for the specified listener.	El listener especificado no admite crear reglas de reenvío.
400	ListenerPortConflict	The specified ListenerPort is conflict with other listener.	El puerto del listener especificado ya está en uso.
400	ResourceNotFound.VServerGroup	%s.	El grupo de servidores especificado no existe.
400	IllegalParam.FailoverThreshold	The parameter FailoverThreshold is illegal.	El FailoverThreshold especificado no es válido. Verifique las restricciones del parámetro y vuelva a intentarlo después de modificarlo.
400	IllegalParam.FailoverStrategy	The parameter FailoverStrategy is illegal.	El FailoverStrategy especificado no es válido. Verifique las restricciones del parámetro y vuelva a intentarlo después de modificarlo.
400	MasterSlaveServerConflict	The servers are conflict for MasterSlaveGroup.	Los servidores backend del grupo de servidores principal/secundario están en conflicto.
400	OperationDenied.HealthCheckClosedForMasterSlaveMode	The operation is denied because of HealthCheckClosedForMasterSlaveMode.	La operación se rechaza porque las comprobaciones de estado deben estar habilitadas en modo principal/secundario.
400	IllegalParam.HealthCheck	The param of HelathCheck is illegal.	El parámetro HealthCheck especificado no es válido. Verifique las restricciones del parámetro e inténtelo de nuevo.
400	Mismatch.SlbSpecTypeAndListenerProtocol	The SlbSpecType and ListenerProtocol are mismatched.	El tipo de especificación de la instancia no coincide con el tipo de listener.
400	OperationDenied.FullNatModeNotAllowed	The operation is not allowed because of FullNatModeNotAllowed.	La operación se rechaza porque no se admite el modo FullNat.
400	OperationDenied.OnlyIpv4SlbSupport	The operation is not allowed because of OnlyIpv4SlbSupport.	La operación se rechaza porque solo las instancias IPv4 admiten habilitar el modo FULL NAT.
400	SpecNotSupportParameter	The instance with share spec does not support FullNatEnabled parameter.	Las instancias de recursos compartidos no admiten el parámetro FullNatEnabled.
400	InvalidParam.TagValue	%s.
400	InvalidParam.TagKey	%s.
400	SizeLimitExceeded.Tag	%s.
400	MissingParam.TagKey	The param MissingParam.TagKey is missing.
400	MissingParameter	The BackendServerPort or VServerGroupId is required at lease one.	El parámetro ListenerPort es obligatorio.
400	AclListenerOverLimit	This acl has reached the limit of binding to listeners.	El número de listeners que se pueden asociar con la ACL especificada ha alcanzado el límite de cuota.
400	QuotaLimitExceeds.AclAttachedToListener	The number of Acl bound listeners has reached the quota limit	El número de listeners asociados a la ACL ha alcanzado el límite de la cuota.
400	QuotaLimitExceeds.TotalAclEntry	The number of Acl entries has reached the quota limit.	El número de entradas de ACL ha alcanzado el límite de la cuota.
400	QuotaLimitExceeds.AclListenerOverLimit	This acl has reached the limit of binding to listeners.	El número de listeners que se pueden asociar con la ACL especificada ha alcanzado el límite de cuota.

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.