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. El sistema devuelve un ID de solicitud, pero el grupo de servidores del Network Load Balancer (NLB) aún no se ha creado y la tarea de creación se sigue ejecutando en segundo plano. Puede llamar a la operación GetJobStatus para consultar el estado de creación del grupo de servidores:

Si el estado de la tarea es Succeeded, el grupo de servidores se ha creado.
Si el estado de la tarea es Processing, el grupo de servidores se está creando. En este estado, solo puede ejecutar operaciones de consulta y no puede ejecutar otras operaciones.

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

nlb:CreateServerGroup

create

*ServerGroup.

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

*VPC.

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ServerGroupType	string	No	El tipo de grupo de servidores. Valores válidos: Instance (predeterminado): tipo de servidor. Este tipo de grupo de servidores admite agregar instancias Ecs, Eni y Eci. Ip: tipo de dirección IP. Este tipo de grupo de servidores admite agregar directamente servidores backend por dirección IP.	Instance
ServerGroupName	string	Sí	El nombre del grupo de servidores. El nombre debe tener de 2 a 128 caracteres de longitud y debe comenzar con una letra o un carácter chino. Puede contener dígitos, puntos (.), guiones bajos (_) y guiones (-).	NLB_ServerGroup
AddressIPVersion	string	No	La versión del protocolo. Valores válidos: ipv4 (predeterminado): IPv4. DualStack: pila doble.	ipv4
IpVersionAffinityMode	string	No	La política de programación de tráfico en modo de pila doble. Valores válidos: NonAffinity (predeterminado): modo de no afinidad. El tráfico se reenvía a los servidores backend en buen estado según el algoritmo de programación, independientemente de la versión del protocolo IP del origen. Affinity: modo de afinidad. El tráfico se reenvía según la versión del protocolo IP del origen de la solicitud. Las solicitudes IPv4 se reenvían solo a servidores backend IPv4, y las solicitudes IPv6 se reenvían solo a servidores backend IPv6. Nota Este parámetro solo surte efecto cuando AddressIPVersion se establece en DualStack.	Affinity
Protocol	string	No	El protocolo de comunicación utilizado para reenviar tráfico a los servidores backend. Valores válidos: TCP (predeterminado) UDP TCP_UDP Nota Si este parámetro se establece en UDP, el grupo de servidores solo se puede asociar con listeners UDP. Si este parámetro se establece en TCP y PreserveClientIpEnabled se establece en true, el grupo de servidores solo se puede asociar con listeners TCP. Si este parámetro se establece en TCP y PreserveClientIpEnabled se establece en false, el grupo de servidores se puede asociar con listeners TCPSSL y TCP. Si este parámetro se establece en TCP_UDP, el grupo de servidores se puede asociar con listeners TCP y UDP.	TCP
VpcId	string	Sí	El ID de la VPC donde se despliega el grupo de servidores. Nota Si ServerGroupType se establece en Instance, solo se pueden agregar al grupo de servidores los servidores de esta VPC.	vpc-bp15zckdt37pq72zv****
AnyPortEnabled	boolean	No	Especifica si se debe habilitar el reenvío de todos los puertos. Valores válidos: true: habilita el reenvío de todos los puertos. false (predeterminado): deshabilita el reenvío de todos los puertos.	false
ConnectionDrainEnabled	boolean	No	Especifica si se debe habilitar el drenaje de conexiones. Valores válidos: true: habilita el drenaje de conexiones. false (predeterminado): deshabilita el drenaje de conexiones.	false
ConnectionDrainTimeout	integer	No	El tiempo de espera para el drenaje de conexiones. Unidad: segundos. Valores válidos: 0 a 900.	10
Scheduler	string	No	El algoritmo de programación. Valores válidos: Wrr (predeterminado): round-robin ponderado. Los servidores backend con mayores pesos tienen más probabilidades de ser seleccionados. Wlc: menor número de conexiones ponderado. Además del peso de cada servidor backend, también se considera la carga real (número de conexiones) del servidor backend. Si los pesos son iguales, los servidores backend con menos conexiones actuales tienen más probabilidades de ser seleccionados. rr: round-robin. Las solicitudes externas se distribuyen a los servidores backend en secuencia. sch: hash de IP de origen. Las solicitudes de la misma dirección IP de origen se programan en el mismo servidor backend. tch: hash de 4-tupla. Hash consistente basado en la 4-tupla (dirección IP de origen, dirección IP de destino, puerto de origen y puerto de destino). Las solicitudes del mismo flujo se programan en el mismo servidor backend. qch: hash de ID de QUIC. Las solicitudes con el mismo ID de QUIC se programan en el mismo servidor backend. Nota El hash de ID de QUIC solo se admite cuando el protocolo backend es UDP.	Wrr
PreserveClientIpEnabled	boolean	No	Especifica si se debe habilitar la conservación de la dirección IP del cliente. Valores válidos: true (predeterminado): habilita la conservación de la dirección IP del cliente. false: deshabilita la conservación de la dirección IP del cliente. Nota Si Protocol se establece en TCP y este parámetro se establece en true, el grupo de servidores no se puede asociar con listeners TCPSSL.	true
HealthCheckConfig	object	No	La configuración de la comprobación de estado.
HealthCheckConnectPort	integer	No	El puerto del servidor backend utilizado para las comprobaciones de estado. Valores válidos: 0 a 65535. Valor predeterminado: 0. Este valor indica que se utiliza el puerto del servidor backend para las comprobaciones de estado.	0
HealthCheckConnectTimeout	integer	No	El tiempo máximo de espera para una respuesta de comprobación de estado. Unidad: segundos. Valores válidos: 1 a 300. Valor predeterminado: 5.	5
HealthCheckDomain	string	No	El nombre de dominio utilizado para las comprobaciones de estado. Valores válidos: $SERVER_IP: la dirección IP interna del servidor backend. domain: un nombre de dominio especificado. El nombre de dominio debe tener de 1 a 80 caracteres de longitud y solo puede contener letras, dígitos, guiones (-) y puntos (.). Nota Este parámetro solo surte efecto cuando HealthCheckType se establece en HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	No	Especifica si se deben habilitar las comprobaciones de estado. Valores válidos: true (predeterminado): habilita las comprobaciones de estado. false: deshabilita las comprobaciones de estado.	true
HealthCheckExp	string	No	La cadena de consulta en la solicitud para las comprobaciones de estado del listener UDP. La cadena solo puede contener letras y dígitos, y puede tener hasta 512 caracteres de longitud.	ok
HealthCheckHttpCode	array	No	Los códigos de estado HTTP para respuestas en buen estado. Separe varios códigos de estado con comas (,). Valores válidos: http_2xx (predeterminado), http_3xx, http_4xx y http_5xx. Nota Este parámetro solo surte efecto cuando HealthCheckType se establece en HTTP.
	string	No	Los códigos de estado HTTP para respuestas en buen estado. Separe varios códigos de estado con comas (,). Valores válidos: http_2xx (predeterminado), http_3xx, http_4xx y http_5xx. Nota Este parámetro solo surte efecto cuando HealthCheckType se establece en HTTP.	http_2xx
HealthCheckHttpVersion	string	No	La versión del protocolo HTTP para las comprobaciones de estado. Valores válidos: HTTP1.0 (predeterminado) y HTTP1.1. Nota Este parámetro solo surte efecto cuando HealthCheckType se establece en HTTP.	HTTP1.0
HealthCheckInterval	integer	No	El intervalo entre dos comprobaciones de estado consecutivas. Unidad: segundos. Valor predeterminado: 5. Si HealthCheckType se establece en TCP o HTTP, los valores válidos son de 1 a 50. Si HealthCheckType se establece en UDP, los valores válidos son de 1 a 300. Debe establecer el intervalo para que sea mayor o igual que el tiempo de espera de respuesta para garantizar que las respuestas de sondeo UDP no se consideren erróneamente como sin respuesta debido a un tiempo de espera agotado.	5
HealthCheckReq	string	No	La cadena de consulta en la solicitud para las comprobaciones de estado del listener UDP. La cadena solo puede contener letras y dígitos, y puede tener hasta 512 caracteres de longitud.	hello
HealthCheckType	string	No	El protocolo utilizado para las comprobaciones de estado. Valores válidos: TCP HTTP UDP	TCP
HealthCheckUrl	string	No	La ruta de comprobación de estado. La ruta debe tener de 1 a 80 caracteres de longitud y solo puede contener letras, dígitos y los siguientes caracteres especiales: `-/.%?#&`. Debe comenzar con una barra diagonal (/). Nota Este parámetro solo surte efecto cuando HealthCheckType se establece en HTTP.	/test/index.html
HealthyThreshold	integer	No	El número de comprobaciones de estado exitosas consecutivas que deben producirse antes de que el estado de comprobación de estado de un servidor backend cambie de fail a success. Valores válidos: 2 a 10. Valor predeterminado: 2.	2
HttpCheckMethod	string	No	El método HTTP utilizado para las comprobaciones de estado. Valores válidos: GET (predeterminado) y HEAD. Nota Este parámetro solo surte efecto cuando HealthCheckType se establece en HTTP.	GET
UnhealthyThreshold	integer	No	El número de comprobaciones de estado fallidas consecutivas que deben producirse antes de que el estado de comprobación de estado de un servidor backend cambie de success a fail. Valores válidos: 2 a 10. Valor predeterminado: 2.	2
ResourceGroupId	string	No	El ID del grupo de recursos al que pertenece el grupo de servidores.	rg-atstuj3rtop****
DryRun	boolean	No	Especifica si solo se debe realizar una comprobación previa de la solicitud. Valores válidos: true: realiza una comprobación previa de la solicitud sin crear el grupo de servidores. El sistema comprueba si se especifican los parámetros requeridos, el formato de la solicitud y los límites del servicio. Si la solicitud no pasa la comprobación previa, se devuelve el error correspondiente. Si la solicitud pasa la comprobación previa, se devuelve el código de error `DryRunOperation`. false (predeterminado): envía la solicitud. Si la solicitud pasa la comprobación previa, se devuelve un código de estado HTTP 2xx y se ejecuta la operación.	true
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el valor, pero debe asegurarse de que sea único entre diferentes solicitudes. El token de cliente solo puede contener caracteres ASCII. Nota Si no especifica este parámetro, el sistema utiliza automáticamente el RequestId de la solicitud de API como ClientToken. El RequestId de cada solicitud de API es único.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	El ID de región de la instancia de Network Load Balancer (NLB). Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
Tag	array<object>	No	La lista de etiquetas.
	object	No	La etiqueta.
Key	string	No	La clave de la etiqueta. La clave de la etiqueta puede tener hasta 64 caracteres de longitud y no puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`. Puede contener letras, dígitos, guiones bajos (_), puntos (.), dos puntos (:), barras diagonales (/), signos iguales (=), signos más (+), guiones (-) y arrobas (@). Puede agregar hasta 20 etiquetas en una sola llamada.	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:`. No puede contener `http://` o `https://`. Puede contener letras, dígitos, guiones bajos (_), puntos (.), dos puntos (:), barras diagonales (/), signos iguales (=), signos más (+), guiones (-) y arrobas (@). Puede agregar hasta 20 etiquetas en una sola llamada.	product

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El grupo de servidores.
JobId	string	El ID de la tarea asíncrona.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	El ID de la solicitud.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	El ID del grupo de servidores.	sgp-atstuj3rtoptyui****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfig	The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal.	La configuración del grupo de servidores está en conflicto con la configuración de comprobación de estado. Verifique los parámetros de configuración.
400	IllegalParamFormat.ParseCreateRsPoolRequestFailed	The param format of CreateRsPoolRequest is illegal.	El formato del parámetro de CreateRsPoolRequestFailed no es válido. Consulte la referencia de la API para verificar los parámetros de la solicitud.
400	IllegalParam.PreserveClientIpSwitch	The param of PreserveClientIpSwitch is illegal.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.	La VPC especificada no admite IPv6.
400	IllegalParam.healthCheckDomain	The parameter of healthCheckConfig.healthCheckDomain is illegal.	El healthCheckDomain de la configuración de comprobación de estado no es válido. Verifique los parámetros de entrada.
400	OperationDenied.UidNotAllowQuic29	The operation is not allowed because of uid not allow quic29 version.
400	IlleagalParam.healthCheckUrl	The parameter of healthCheckUrl in healthCheckConfig is illegal.	La URL de comprobación de estado utilizada en la configuración de comprobación de estado no es válida.
400	IllegalParam.ServerGroupName	The param of ServerGroupName is illegal.	El parámetro ServerGroupName no es válido.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	La solicitud DryRun pasó la validación.
400	MissingParam.%s	The parameter of %s is missing.	Falta el parámetro %s. Verifique los parámetros de entrada.
400	IllegalParam.ConnectionDrainTimeout	The param of ConnectionDrainTimeout is illegal.	El parámetro ConnectionDrainTimeout no es válido. Verifique los parámetros de entrada.
400	IllegalParam	The param of %s is illegal.	Los parámetros de entrada contienen valores no válidos. Verifique los datos de entrada.
400	SystemBusy	System is busy, please try again later.	El sistema está ocupado. Vuelva a intentarlo más tarde.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.	La cuota es insuficiente. En uso: %s/%s. Modifique la cuota en Quota Center.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	La autenticación falló porque la cuenta no tiene los permisos requeridos.
404	ResourceNotFound.Vpc	The specified resource of Vpc is not found.	No se encuentra el recurso de VPC especificado. Verifique los parámetros de entrada.
404	ResourceNotFound.ResourceGroup	The param of resourceGroup not existed.	El grupo de recursos 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.