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

Crea un grupo de servidores en una región especificada.

Descripción de la operación

La operación CreateServerGroup es asíncrona. Después de enviar una solicitud, el sistema devuelve un ID de solicitud. Sin embargo, el grupo de servidores aún no se ha creado. La tarea de creación continúa ejecutándose en segundo plano. Puede llamar a ListServerGroups para consultar el estado de creación del grupo de servidores:

Si el grupo de servidores está en estado Creating, significa que se está creando.
Si el grupo de servidores está en estado Available, significa que ya se creó.

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

create

*ServerGroup.

acs:alb:{#regionId}:{#accountId}:servergroup/*

alb:ServerGroupProtocol

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ServerGroupName	string	Sí	El nombre del grupo de servidores. El nombre debe tener entre 2 y 128 caracteres de longitud, y debe comenzar con una letra mayúscula, una letra minúscula, un carácter chino o un dígito. El nombre puede contener dígitos, puntos (.), guiones bajos (_), guiones (-) y espacios.	test
ServerGroupType	string	No	El tipo del grupo de servidores. Valores válidos: Instance (predeterminado): tipo servidor. Este tipo de grupo de servidores admite agregar instancias Ecs, Eni y Eci. Ip: tipo dirección IP. Este tipo de grupo de servidores admite agregar servidores backend mediante dirección IP. Fc: tipo Function Compute. Este tipo admite agregar servidores backend basados en Function Compute.	Instance
VpcId	string	No	El ID de la instancia conectada a la VPC. Solo se pueden agregar al grupo de servidores los servidores que se encuentren en esta VPC. Nota Este parámetro solo surte efecto cuando ServerGroupType se establece en Instance o Ip.	vpc-bp15zdkdt37pq72zv****
Scheduler	string	No	El algoritmo de programación. Valores válidos: Wrr (predeterminado): round-robin ponderado. Los servidores backend con pesos más altos reciben más solicitudes. Wlc: menor número de conexiones ponderado. Además del peso asignado a cada servidor backend, también se considera la carga real (número de conexiones). Cuando los pesos son iguales, los servidores backend con menos conexiones actuales reciben más solicitudes. Sch: hash consistente. Las solicitudes con el mismo factor de hash se enrutan al mismo servidor backend. Si no se configura el parámetro UchConfig, el factor de hash predeterminado es la dirección IP de origen, y las solicitudes provenientes de la misma dirección IP de origen se distribuyen al mismo servidor backend. Si se configura el parámetro UchConfig, el factor de hash es el parámetro de URL, y las solicitudes con el mismo parámetro de URL se distribuyen al mismo servidor backend. Nota Este parámetro solo surte efecto cuando ServerGroupType se establece en Instance o Ip.	Wrr
Protocol	string	No	El protocolo backend. Valores válidos: HTTP (predeterminado): se puede asociar con listeners HTTPS, HTTP y QUIC. HTTPS: se puede asociar con listeners HTTPS. gRPC: se puede asociar con listeners HTTPS y QUIC. Nota No es necesario configurar el protocolo backend cuando ServerGroupType se establece en Fc.	HTTP
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-atstuj3rsop****
HealthCheckConfig	object	Sí	Las configuraciones de verificación de estado.	rg-123
HealthCheckConnectPort	integer	No	El puerto del servidor backend utilizado para las verificaciones de estado. Valores válidos: 0 a 65535. Valor predeterminado: 0, lo que indica que se utiliza el puerto del servidor backend para las verificaciones de estado.	80
HealthCheckEnabled	boolean	Sí	Especifica si se deben habilitar las verificaciones de estado. Valores válidos: true: habilitado. false: deshabilitado. Nota Las verificaciones de estado están habilitadas de forma predeterminada cuando ServerGroupType se establece en Instance o Ip. Las verificaciones de estado están deshabilitadas de forma predeterminada cuando ServerGroupType se establece en Fc.	true
HealthCheckHost	string	No	El nombre de dominio utilizado para las verificaciones de estado. Usar la dirección IP interna del servidor backend (predeterminado): utiliza la dirección IP interna del servidor backend como nombre de dominio de verificación de estado. Especificar un nombre de dominio específico: introduzca un nombre de dominio. El nombre de dominio debe tener entre 1 y 80 caracteres de longitud. El nombre de dominio puede contener letras minúsculas, dígitos, guiones (-) y puntos (.). El nombre de dominio debe contener al menos un punto (.). Los puntos (.) no pueden aparecer al principio ni al final. La etiqueta de dominio más a la derecha solo puede contener letras, no dígitos ni guiones (-). Los guiones (-) no pueden aparecer al principio ni al final. Nota Este parámetro solo surte efecto cuando HealthCheckProtocol se establece en HTTP, HTTPS o gRPC.	www.example.com
HealthCheckCodes	array	No	La lista de códigos de estado que indican un estado de verificación de estado Normal.
	string	No	El código de estado que indica un estado de verificación de estado Normal. Cuando HealthCheckProtocol se establece en HTTP o HTTPS, los valores válidos para HealthCheckCodes son http_2xx (predeterminado), http_3xx, http_4xx y http_5xx. Separe varios códigos de estado con comas (,). Cuando HealthCheckProtocol se establece en gRPC, los valores válidos para HealthCheckCodes van de 0 a 99. Valor predeterminado: 0. Se admite la entrada de rangos, con un máximo de 20 valores de rango. Separe varios valores de rango con comas (,). Nota Este parámetro surte efecto cuando HealthCheckProtocol se establece en HTTP, HTTPS o gRPC.	http_2xx
HealthCheckHttpVersion	string	No	La versión de HTTP para las verificaciones de estado. Valores válidos: HTTP1.0 y HTTP1.1 (predeterminado). Nota Este parámetro solo surte efecto cuando HealthCheckProtocol se establece en HTTP o HTTPS.	HTTP1.1
HealthCheckInterval	integer	No	El intervalo entre dos verificaciones de estado consecutivas. Unidad: segundos. Valores válidos: 1 a 50. Valor predeterminado: 2.	2
HealthCheckMethod	string	No	El método de verificación de estado. Valores válidos: GET: Si el cuerpo de la respuesta excede los 8 KB, se trunca. Sin embargo, esto no afecta el resultado de la verificación de estado. POST: Las verificaciones de estado del listener gRPC utilizan el método POST de forma predeterminada. HEAD (predeterminado): Las verificaciones de estado de los listeners HTTP y HTTPS utilizan el método HEAD de forma predeterminada. Nota Este parámetro solo surte efecto cuando HealthCheckProtocol se establece en HTTP, HTTPS o gRPC.	HEAD
HealthCheckPath	string	No	La ruta de la regla de reenvío para las verificaciones de estado. La ruta debe tener entre 1 y 80 caracteres de longitud y solo puede contener letras, dígitos y los caracteres `-/.%?#&=` y los caracteres extendidos `_;~!（)[]@$^:',+`. La URL debe comenzar con una barra diagonal (/). Nota* Este parámetro solo surte efecto cuando HealthCheckProtocol se establece en HTTP o HTTPS.	/test/index.html
HealthCheckProtocol	string	No	El protocolo de verificación de estado. Valores válidos: HTTP: simula el comportamiento de acceso del navegador enviando solicitudes HEAD o GET para verificar si la aplicación del servidor está en buen estado. HTTPS: simula el comportamiento de acceso del navegador enviando solicitudes HEAD o GET para verificar si la aplicación del servidor está en buen estado. Utiliza cifrado de datos, lo que lo hace más seguro que HTTP. TCP: envía paquetes de enlace SYN para verificar si el puerto del servidor está activo. gRPC: envía solicitudes POST o GET para verificar si la aplicación del servidor está en buen estado.	HTTP
HealthCheckTimeout	integer	No	El período máximo de tiempo para esperar una respuesta de una verificación de estado. Si el servidor backend no responde correctamente dentro del período de tiempo especificado, la verificación de estado falla. Unidad: segundos. Valores válidos: 1 a 300. Valor predeterminado: 5.	5
HealthyThreshold	integer	No	El número de verificaciones de estado exitosas consecutivas necesarias antes de que el estado de verificación de estado de un servidor backend cambie de fail a success. Valores válidos: 2 a 10. Valor predeterminado: 3.	3
UnhealthyThreshold	integer	No	El número de verificaciones de estado fallidas consecutivas necesarias antes de que el estado de verificación de estado de un servidor backend cambie de success a fail. Valores válidos: 2 a 10. Valor predeterminado: 3.	3
StickySessionConfig	object	No	La configuración de persistencia de sesión. Nota Este parámetro solo surte efecto cuando ServerGroupType se establece en Instance o Ip.
Cookie	string	No	La cookie configurada en el servidor. La cookie debe tener entre 1 y 200 caracteres de longitud y solo puede contener letras ASCII y dígitos. No puede contener comas (,), punto y coma (;) ni espacios, y no puede comenzar con un signo de dólar ($). Nota Este parámetro surte efecto cuando StickySessionEnabled se establece en true y StickySessionType se establece en server.	B490B6EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	No	El tiempo de espera de la cookie. Unidad: segundos. Valores válidos: 1 a 86400. Valor predeterminado: 1000. Nota Este parámetro surte efecto cuando StickySessionEnabled se establece en true y StickySessionType se establece en Insert.	1000
StickySessionEnabled	boolean	No	Especifica si se debe habilitar la persistencia de sesión. Valores válidos: true: habilitado. false: deshabilitado. Nota Este parámetro solo surte efecto cuando ServerGroupType se establece en Instance o Ip.	false
StickySessionType	string	No	El método utilizado para gestionar las cookies. Valores válidos: Insert (predeterminado): inserta una cookie. Cuando un cliente accede por primera vez al load balancer, este inserta una cookie (SERVERID) en la respuesta HTTP o HTTPS. Las solicitudes posteriores que llevan esta cookie se reenvían al servidor backend registrado previamente. Server: reescribe una cookie. Cuando el servicio de balanceo de carga detecta una cookie definida por el usuario, reescribe la cookie original. Las solicitudes posteriores que llevan la nueva cookie se reenvían al servidor backend registrado previamente. Nota Este parámetro surte efecto cuando StickySessionEnabled se establece en true.	Insert
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Genere un valor de parámetro desde su cliente para garantizar que el valor sea único entre diferentes solicitudes. ClientToken solo admite caracteres ASCII. Nota Si no especifica este parámetro, el sistema utiliza el RequestId de la solicitud de API como ClientToken. El RequestId puede variar para cada solicitud de API.	5A2CAF0E-5718-45B5-9D4D-70B******
DryRun	boolean	No	Especifica si se debe realizar una ejecución de prueba (dry run). Valores válidos: true: realiza una ejecución de prueba sin crear el grupo de servidores. El sistema verifica los parámetros obligatorios, la sintaxis de la solicitud y las restricciones comerciales. Si la verificación falla, se devuelve el error correspondiente. Si la verificación tiene éxito, se devuelve el código de error `DryRunOperation`. false (predeterminado): envía una solicitud normal. Después de que la verificación tenga éxito, se devuelve un código de estado HTTP 2xx y se ejecuta la operación.	false
Ipv6Enabled	boolean	No	Especifica si se debe habilitar IPv6.	true
UpstreamKeepaliveEnabled	boolean	No	Especifica si se deben habilitar las conexiones keepalive upstream. true: habilitado. false (predeterminado): deshabilitado.	false
ServiceName	string	No	Este parámetro solo es aplicable a escenarios de ALB Ingress y especifica el nombre del `K8s Service` que corresponde al grupo de servidores.	test
UchConfig	object	No	La configuración de parámetros de hash consistente de URL.
Type	string	Sí	El tipo de parámetro. Establezca el valor en QueryString.	QueryString
Value	string	Sí	El valor del parámetro de hash consistente.	abc
ConnectionDrainConfig	object	No	La configuración de drenaje de conexiones. Después de habilitar el drenaje de conexiones, cuando se elimina un servidor backend o ocurre un fallo en la verificación de estado, el servicio de balanceo de carga permite que las conexiones existentes continúen la transmisión normal de datos durante un período de tiempo especificado. Nota Las instancias Basic Edition no admiten el drenaje de conexiones. Solo las instancias Standard Edition y WAF Enhanced Edition admiten esta función. Los grupos de servidores de tipo servidor y de tipo IP admiten el drenaje de conexiones. Los grupos de servidores de tipo Function Compute no lo admiten.
ConnectionDrainEnabled	boolean	No	Especifica si se debe habilitar el drenaje de conexiones. true: habilitado. false: deshabilitado (predeterminado).	false
ConnectionDrainTimeout	integer	No	El tiempo de espera del drenaje de conexiones. Valores válidos: 0 a 900. Valor predeterminado: 300.	300
SlowStartConfig	object	No	La configuración de inicio lento. Después de habilitar el inicio lento, los servidores backend recién agregados se preparan durante un período de tiempo especificado. El número de solicitudes reenviadas al servidor aumenta linealmente. Nota Las instancias Basic Edition no admiten el inicio lento. Solo las instancias Standard Edition y WAF Enhanced Edition admiten esta función. Los grupos de servidores backend de tipo servidor y de tipo IP admiten la configuración de inicio lento. Los grupos de servidores backend de Function Compute no la admiten. El inicio lento solo se puede habilitar cuando el algoritmo de programación backend es round-robin ponderado.
SlowStartEnabled	boolean	No	Especifica si se debe habilitar el inicio lento. true: habilitado. false: deshabilitado (predeterminado).	false
SlowStartDuration	integer	No	La duración del inicio lento. Valores válidos: 30 a 900. Valor predeterminado: 30.	30
Tag	array<object>	No	Las etiquetas.
	object	No	La estructura de la etiqueta.
Key	string	No	La clave de la etiqueta. La clave de la etiqueta puede tener hasta 128 caracteres de longitud, y no puede comenzar con `aliyun` o `acs:`, ni contener `http://` o `https://`.	env
Value	string	No	El valor de la etiqueta. El valor de la etiqueta puede tener hasta 128 caracteres de longitud, y no puede comenzar con `aliyun` o `acs:`, ni contener `http://` o `https://`.	product
CrossZoneEnabled	boolean	No	Especifica si se debe habilitar el balanceo de carga entre zonas para el grupo de servidores. Valores válidos: true: habilitado (predeterminado). false: deshabilitado. Nota Las instancias Basic Edition no admiten la vinculación de grupos de servidores con el balanceo de carga entre zonas deshabilitado. Solo las instancias Standard Edition y WAF Enhanced Edition admiten esta función. Los grupos de servidores de tipo servidor y de tipo IP admiten deshabilitar el balanceo de carga entre zonas. Los grupos de servidores de tipo Function Compute no lo admiten. La persistencia de sesión no se admite cuando el balanceo de carga entre zonas está deshabilitado.	true
IpVersionAffinityMode	string	No	El modo de afinidad de versión de IP.	Affinity

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La estructura de la respuesta.
JobId	string	El ID de la tarea asíncrona.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	El ID de la solicitud.	365F4154-92F6-4AE4-92F8-7FF******
ServerGroupId	string	El ID del grupo de servidores.	sgp-8ilqs4axp6******

Ejemplos

Respuesta exitosa

JSON Formato

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "ServerGroupId": "sgp-8ilqs4axp6******"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded, usage %s/%s.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.
400	Mismatch.ServerGroupSchedulerAndSlowStartEnable	The %s and %s are mismatched.
400	QuotaExceeded.SlowStartDuration	The quota of %s is exceeded, usage %s/%s.
400	UnsupportedFeature.SlowStart	The feature of %s is not supported.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.
400	QuotaExceeded.ConnectionDrainTimeout	The quota of %s is exceeded, usage %s/%s.
400	UnsupportedFeature.ConnectionDrain	The feature of %s is not supported.
400	NotExist.ResourceGroup	ResourceGroup does not exist.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.
400	UnsupportedFeature.FcServerGroup	Server groups of type FC are not supported.
404	ResourceNotFound.Vpc	The specified resource %s is not found.

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.