CreateServerGroup - Server Load Balancer: Central de Documentação do Alibaba Cloud

Cria um grupo de servidores em uma região especificada.

Descrição da operação

A operação CreateServerGroup é assíncrona. Após o envio de uma solicitação, o sistema retorna um ID de solicitação. No entanto, o grupo de servidores ainda não foi criado. A tarefa de criação continua sendo executada em segundo plano. Você pode chamar ListServerGroups para consultar o status de criação do grupo de servidores:

Se o grupo de servidores estiver no estado Creating, o grupo de servidores está sendo criado.
Se o grupo de servidores estiver no estado Available, o grupo de servidores foi criado.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

alb:CreateServerGroup

create

*ServerGroup

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

alb:ServerGroupProtocol

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ServerGroupName	string	Sim	O nome do grupo de servidores. O nome deve ter de 2 a 128 caracteres e deve começar com uma letra maiúscula, letra minúscula, caractere chinês ou dígito. O nome pode conter dígitos, pontos (.), sublinhados (_), hifens (-) e espaços.	test
ServerGroupType	string	Não	O tipo do grupo de servidores. Valores válidos: Instance (padrão): tipo servidor. Este tipo de grupo de servidores suporta a adição de instâncias Ecs, Eni e Eci. Ip: tipo endereço IP. Este tipo de grupo de servidores suporta a adição de servidores back-end por endereço IP. Fc: tipo Function Compute. Este tipo suporta a adição de servidores back-end baseados no Function Compute.	Instance
VpcId	string	Não	O ID da instância conectada à VPC. Apenas servidores nesta VPC podem ser adicionados ao grupo de servidores. Nota Este parâmetro entra em vigor apenas quando ServerGroupType está definido como Instance ou Ip.	vpc-bp15zdkdt37pq72zv****
Scheduler	string	Não	O algoritmo de agendamento. Valores válidos: Wrr (padrão): round-robin ponderado. Servidores back-end com pesos maiores recebem mais solicitações. Wlc: menor número de conexões ponderado. Além do peso atribuído a cada servidor back-end, a carga real (número de conexões) também é considerada. Quando os pesos são iguais, os servidores back-end com menos conexões atuais recebem mais solicitações. Sch: hash consistente. Solicitações com o mesmo fator de hash são roteadas para o mesmo servidor back-end. Se o parâmetro UchConfig não estiver configurado, o fator de hash padrão é o endereço IP de origem, e as solicitações do mesmo endereço IP de origem são distribuídas para o mesmo servidor back-end. Se o parâmetro UchConfig estiver configurado, o fator de hash é o parâmetro da URL, e as solicitações com o mesmo parâmetro de URL são distribuídas para o mesmo servidor back-end. Nota Este parâmetro entra em vigor apenas quando ServerGroupType está definido como Instance ou Ip.	Wrr
Protocol	string	Não	O protocolo back-end. Valores válidos: HTTP (padrão): pode ser associado a listeners HTTPS, HTTP e QUIC. HTTPS: pode ser associado a listeners HTTPS. gRPC: pode ser associado a listeners HTTPS e QUIC. Nota Não é necessário configurar o protocolo back-end quando ServerGroupType está definido como Fc.	HTTP
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-atstuj3rsop****
HealthCheckConfig	object	Sim	As configurações de verificação de integridade.	rg-123
HealthCheckConnectPort	integer	Não	A porta do servidor back-end usada para verificações de integridade. Valores válidos: 0 a 65535. Valor padrão: 0, que indica que a porta do servidor back-end é usada para verificações de integridade.	80
HealthCheckEnabled	boolean	Sim	Especifica se as verificações de integridade devem ser ativadas. Valores válidos: true: ativado. false: desativado. Nota As verificações de integridade são ativadas por padrão quando ServerGroupType está definido como Instance ou Ip. As verificações de integridade são desativadas por padrão quando ServerGroupType está definido como Fc.	true
HealthCheckHost	string	Não	O nome de domínio usado para verificações de integridade. Usar o endereço IP interno do servidor back-end (padrão): usa o endereço IP interno do servidor back-end como o nome de domínio de verificação de integridade. Especificar um nome de domínio específico: insira um nome de domínio. O nome de domínio deve ter de 1 a 80 caracteres. O nome de domínio pode conter letras minúsculas, dígitos, hifens (-) e pontos (.). O nome de domínio deve conter pelo menos um ponto (.). Os pontos (.) não podem aparecer no início ou no final. O rótulo de domínio mais à direita pode conter apenas letras, não dígitos ou hifens (-). Hifens (-) não podem aparecer no início ou no final. Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	www.example.com
HealthCheckCodes	array	Não	A lista de códigos de status que indicam um status de verificação de integridade Normal.
	string	Não	O código de status que indica um status de verificação de integridade Normal. Quando HealthCheckProtocol está definido como HTTP ou HTTPS, os valores válidos para HealthCheckCodes são http_2xx (padrão), http_3xx, http_4xx e http_5xx. Separe vários códigos de status com vírgulas (,). Quando HealthCheckProtocol está definido como gRPC, os valores válidos para HealthCheckCodes variam de 0 a 99. Valor padrão: 0. A entrada de intervalo é suportada, com um máximo de 20 valores de intervalo. Separe vários valores de intervalo com vírgulas (,). Nota Este parâmetro entra em vigor quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	http_2xx
HealthCheckHttpVersion	string	Não	A versão HTTP para verificações de integridade. Valores válidos: HTTP1.0 e HTTP1.1 (padrão). Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP ou HTTPS.	HTTP1.1
HealthCheckInterval	integer	Não	O intervalo entre duas verificações de integridade consecutivas. Unidade: segundos. Valores válidos: 1 a 50. Valor padrão: 2.	2
HealthCheckMethod	string	Não	O método de verificação de integridade. Valores válidos: GET: Se o corpo da resposta exceder 8 KB, ele será truncado. No entanto, isso não afeta o resultado da verificação de integridade. POST: As verificações de integridade de listener gRPC usam o método POST por padrão. HEAD (padrão): As verificações de integridade de listener HTTP e HTTPS usam o método HEAD por padrão. Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	HEAD
HealthCheckPath	string	Não	O caminho da regra de encaminhamento para verificações de integridade. O caminho deve ter de 1 a 80 caracteres e pode conter apenas letras, dígitos e os caracteres `-/.%?#&=` e os caracteres estendidos `_;~!（)[]@$^:',+`. A URL deve começar com uma barra (/). Nota* Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP ou HTTPS.	/test/index.html
HealthCheckProtocol	string	Não	O protocolo de verificação de integridade. Valores válidos: HTTP: usa a simulação de comportamento de acesso do navegador enviando solicitações HEAD ou GET para verificar se o aplicativo do servidor está íntegro. HTTPS: usa a simulação de comportamento de acesso do navegador enviando solicitações HEAD ou GET para verificar se o aplicativo do servidor está íntegro. A criptografia de dados é usada, o que é mais seguro que o HTTP. TCP: envia pacotes de handshake SYN para verificar se a porta do servidor está ativa. gRPC: envia solicitações POST ou GET para verificar se o aplicativo do servidor está íntegro.	HTTP
HealthCheckTimeout	integer	Não	O período máximo de tempo para aguardar uma resposta de uma verificação de integridade. Se o servidor back-end não responder corretamente dentro do período de tempo especificado, a verificação de integridade falhará. Unidade: segundos. Valores válidos: 1 a 300. Valor padrão: 5.	5
HealthyThreshold	integer	Não	O número de verificações de integridade bem-sucedidas consecutivas necessárias antes que o status de verificação de integridade de um servidor back-end mude de fail para success. Valores válidos: 2 a 10. Valor padrão: 3.	3
UnhealthyThreshold	integer	Não	O número de verificações de integridade com falha consecutivas necessárias antes que o status de verificação de integridade de um servidor back-end mude de success para fail. Valores válidos: 2 a 10. Valor padrão: 3.	3
StickySessionConfig	object	Não	As configurações de persistência de sessão. Nota Este parâmetro entra em vigor apenas quando ServerGroupType está definido como Instance ou Ip.
Cookie	string	Não	O cookie configurado no servidor. O cookie deve ter de 1 a 200 caracteres e pode conter apenas letras ASCII e dígitos. Não pode conter vírgulas (,), ponto e vírgula (;) ou espaços, e não pode começar com um cifrão ($). Nota Este parâmetro entra em vigor quando StickySessionEnabled está definido como true e StickySessionType está definido como server.	B490B6EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	Não	O período de tempo limite do cookie. Unidade: segundos. Valores válidos: 1 a 86400. Valor padrão: 1000. Nota Este parâmetro entra em vigor quando StickySessionEnabled está definido como true e StickySessionType está definido como Insert.	1000
StickySessionEnabled	boolean	Não	Especifica se a persistência de sessão deve ser ativada. Valores válidos: true: ativado. false: desativado. Nota Este parâmetro entra em vigor apenas quando ServerGroupType está definido como Instance ou Ip.	false
StickySessionType	string	Não	O método usado para lidar com cookies. Valores válidos: Insert (padrão): insere um cookie. Quando um cliente acessa o load balancer pela primeira vez, o load balancer insere um cookie (SERVERID) na resposta HTTP ou HTTPS. As solicitações subsequentes que carregam esse cookie são encaminhadas para o servidor back-end registrado anteriormente. Server: reescreve um cookie. Quando o serviço de balanceamento de carga detecta um cookie definido pelo usuário, ele reescreve o cookie original. As solicitações subsequentes que carregam o novo cookie são encaminhadas para o servidor back-end registrado anteriormente. Nota Este parâmetro entra em vigor quando StickySessionEnabled está definido como true.	Insert
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Gere um valor de parâmetro a partir do seu cliente para garantir que o valor seja único entre diferentes solicitações. ClientToken suporta apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará o RequestId da solicitação de API como o ClientToken. O RequestId pode variar para cada solicitação de API.	5A2CAF0E-5718-45B5-9D4D-70B******
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: realiza um dry run sem criar o grupo de servidores. O sistema verifica os parâmetros obrigatórios, a sintaxe da solicitação e as restrições de negócios. Se a verificação falhar, o erro correspondente será retornado. Se a verificação for bem-sucedida, o código de erro `DryRunOperation` será retornado. false (padrão): envia uma solicitação normal. Após a verificação ser bem-sucedida, um código de status HTTP 2xx é retornado e a operação é executada.	false
Ipv6Enabled	boolean	Não	Especifica se o IPv6 deve ser ativado.	true
UpstreamKeepaliveEnabled	boolean	Não	Especifica se as conexões keepalive upstream devem ser ativadas. true: ativado. false (padrão): desativado.	false
ServiceName	string	Não	Este parâmetro é aplicável apenas a cenários ALB Ingress e especifica o nome do `K8s Service` que corresponde ao grupo de servidores.	test
UchConfig	object	Não	As configurações de parâmetro de hash consistente de URL.
Type	string	Sim	O tipo de parâmetro. Defina o valor como QueryString.	QueryString
Value	string	Sim	O valor do parâmetro de hash consistente.	abc
ConnectionDrainConfig	object	Não	A configuração de drenagem de conexão. Após a ativação da drenagem de conexão, quando um servidor back-end é removido ou ocorre uma falha na verificação de integridade, o serviço de balanceamento de carga permite que as conexões existentes continuem a transmissão normal de dados por um período de tempo especificado. Nota Instâncias Basic Edition não suportam drenagem de conexão. Apenas instâncias Standard Edition e WAF Enhanced Edition suportam esse recurso. Grupos de servidores do tipo servidor e do tipo IP suportam drenagem de conexão. Grupos de servidores do tipo Function Compute não suportam.
ConnectionDrainEnabled	boolean	Não	Especifica se a drenagem de conexão deve ser ativada. true: ativado. false: desativado (padrão).	false
ConnectionDrainTimeout	integer	Não	O período de tempo limite de drenagem de conexão. Valores válidos: 0 a 900. Valor padrão: 300.	300
SlowStartConfig	object	Não	A configuração de início lento. Após a ativação do início lento, os servidores back-end recém-adicionados são aquecidos durante um período de tempo especificado. O número de solicitações encaminhadas para o servidor aumenta linearmente. Nota Instâncias Basic Edition não suportam início lento. Apenas instâncias Standard Edition e WAF Enhanced Edition suportam esse recurso. Grupos de servidores back-end do tipo servidor e do tipo IP suportam a configuração de início lento. Grupos de servidores back-end do tipo Function Compute não suportam. O início lento só pode ser ativado quando o algoritmo de agendamento back-end é round-robin ponderado.
SlowStartEnabled	boolean	Não	Especifica se o início lento deve ser ativado. true: ativado. false: desativado (padrão).	false
SlowStartDuration	integer	Não	A duração do início lento. Valores válidos: 30 a 900. Valor padrão: 30.	30
Tag	array<object>	Não	As tags.
	object	Não	A estrutura da tag.
Key	string	Não	A chave da tag. A chave da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`, nem conter `http://` ou `https://`.	env
Value	string	Não	O valor da tag. O valor da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`, nem conter `http://` ou `https://`.	product
CrossZoneEnabled	boolean	Não	Especifica se o balanceamento de carga entre zonas deve ser ativado para o grupo de servidores. Valores válidos: true: ativado (padrão). false: desativado. Nota Instâncias Basic Edition não suportam a vinculação de grupos de servidores com o balanceamento de carga entre zonas desativado. Apenas instâncias Standard Edition e WAF Enhanced Edition suportam esse recurso. Grupos de servidores do tipo servidor e do tipo IP suportam a desativação do balanceamento de carga entre zonas. Grupos de servidores do tipo Function Compute não suportam. A persistência de sessão não é suportada quando o balanceamento de carga entre zonas está desativado.	true
IpVersionAffinityMode	string	Não	O modo de afinidade da versão IP.	Affinity

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
JobId	string	O ID da tarefa assíncrona.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	O ID da solicitação.	365F4154-92F6-4AE4-92F8-7FF******
ServerGroupId	string	O ID do grupo de servidores.	sgp-8ilqs4axp6******

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded, usage %s/%s.	A cota %s foi excedida. Uso atual: %s. Cota: %s.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.	Os parâmetros %s e %s não correspondem.
400	Mismatch.ServerGroupSchedulerAndSlowStartEnable	The %s and %s are mismatched.	Os parâmetros %s e %s não correspondem.
400	QuotaExceeded.SlowStartDuration	The quota of %s is exceeded, usage %s/%s.	O parâmetro %s excede o limite de cota. Valor atual: %s. Cota: %s.
400	UnsupportedFeature.SlowStart	The feature of %s is not supported.	O recurso %s não é suportado.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.	Os parâmetros %s e %s não correspondem.
400	QuotaExceeded.ConnectionDrainTimeout	The quota of %s is exceeded, usage %s/%s.	O parâmetro %s excede o limite de cota. Valor atual: %s. Cota: %s.
400	UnsupportedFeature.ConnectionDrain	The feature of %s is not supported.	O recurso %s não é suportado.
400	NotExist.ResourceGroup	ResourceGroup does not exist.	O grupo de recursos não existe.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.	A VPC não suporta IPv6 e não pode ser alterada para pilha dupla.
400	UnsupportedFeature.FcServerGroup	Server groups of type FC are not supported.	O grupo de servidores do tipo FC não é suportado.
404	ResourceNotFound.Vpc	The specified resource %s is not found.	A VPC não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.