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

Cria um grupo de servidores para uma instância do Gateway Load Balancer (GWLB).

Descrição da operação

CreateServerGroup é uma operação assíncrona. Após o envio de uma solicitação, o sistema retorna um ID de solicitação e executa a tarefa em segundo plano. Você pode chamar a operação ListServerGroups para consultar o status da tarefa.

Se o grupo de servidores estiver no estado Creating, isso indica que o grupo de servidores está sendo criado.
Se o grupo de servidores estiver no estado Available, isso indica que 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

gwlb:CreateServerGroup

create

*ServerGroup

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

*VPC

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ServerGroupType	string	Não	O tipo do grupo de servidores. Valores válidos: Instance (padrão): permite especificar recursos do tipo Ecs, Eni ou Eci. Ip: permite adicionar servidores especificando seus endereços IP.	Instance
ServerGroupName	string	Não	O nome do grupo de servidores. O nome deve ter de 2 a 128 caracteres e pode conter dígitos, pontos (.), underscores (_) e hífens (-). Deve começar com uma letra.	testServerGroupName
Protocol	string	Não	O protocolo de backend. Valor válido: GENEVE (padrão) Valores válidos: GENEVE : GENEVE.	GENEVE
Scheduler	string	Não	O algoritmo de agendamento. Valores válidos: 5TCH (padrão): especifica hashing consistente com base nos seguintes fatores: endereço IP de origem, endereço IP de destino, porta de origem, protocolo e porta de destino. Solicitações que contêm as mesmas informações com base nos fatores anteriores são encaminhadas para o mesmo servidor de backend. 3TCH: especifica hashing consistente com base nos seguintes fatores: endereço IP de origem, endereço IP de destino e protocolo. Solicitações que contêm as mesmas informações com base nos fatores anteriores são encaminhadas para o mesmo servidor de backend. 2TCH: especifica hashing consistente com base nos seguintes fatores: endereço IP de origem e endereço IP de destino. Solicitações que contêm as mesmas informações com base nos fatores anteriores são encaminhadas para o mesmo servidor de backend.	5TCH
ServerFailoverMode	string	Não	Especifica como o GWLB processa solicitações em conexões existentes quando um servidor de backend não está funcionando conforme esperado. Valores válidos: NoRebalance (padrão): o GWLB continua encaminhando solicitações em conexões existentes para o servidor de backend indisponível. Rebalance: o GWLB encaminha solicitações em conexões existentes para os servidores de backend saudáveis restantes.	NoRebalance
VpcId	string	Sim	O ID da VPC. Nota Se ServerGroupType estiver definido como Instance, somente servidores na VPC especificada poderão ser adicionados ao grupo de servidores.	vpc-bp15zckdt37pq72zv****
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-atstuj3rtop****
ConnectionDrainConfig	object	Não	As configurações de drenagem de conexão.
ConnectionDrainEnabled	boolean	Não	Especifica se a drenagem de conexão deve ser ativada. Valores válidos: true false	false
ConnectionDrainTimeout	integer	Não	O período de timeout da drenagem de conexão. Unidade: segundos. Valores válidos: 1 a 3600. Valor padrão: 300.	300
HealthCheckConfig	object	Não	As configurações de verificação de integridade.
HealthCheckConnectPort	integer	Não	A porta do servidor de backend usada para verificações de integridade. Valores válidos: 1 a 65535. Valor padrão: 80.	80
HealthCheckConnectTimeout	integer	Não	O período máximo de timeout para uma resposta de verificação de integridade. Unidade: segundos. Valores válidos: 1 a 300. Valor padrão: 5.	5
HealthCheckDomain	string	Não	O nome de domínio usado para verificações de integridade. Valores válidos: $SERVER_IP (padrão): o endereço IP privado de um servidor de backend. domain: um nome de domínio. O nome de domínio deve ter de 1 a 80 caracteres e pode conter letras, dígitos, hífens (-) e pontos (.). Nota Este parâmetro entra em vigor somente se você definir HealthCheckProtocol como HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	Não	Especifica se as verificações de integridade devem ser ativadas. Valores válidos: true (padrão) false	true
HealthCheckHttpCode	array	Não	Os códigos de status HTTP que o sistema retorna para verificações de integridade.
	string	Não	Os códigos de status HTTP retornados para verificações de integridade. Múltiplos códigos de status HTTP são separados por vírgulas (,). Valores válidos: http_2xx http_3xx http_4xx http_5xx Valor padrão: http_2xx. Nota Este parâmetro entra em vigor somente se você definir HealthCheckProtocol como HTTP.	http_2xx
HealthCheckInterval	integer	Não	O intervalo no qual as verificações de integridade são realizadas. Unidade: segundos. Valores válidos: 1 a 50. Valor padrão: 10.	10
HealthCheckPath	string	Não	O caminho usado para verificações de integridade. Deve ter de 1 a 80 caracteres e pode conter letras, dígitos, hífens (-), barras (/), pontos (.), sinais de porcentagem (%), pontos de interrogação (?), sinais de número (#) e "e" comercial (&). A URL também pode conter os seguintes caracteres estendidos: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + = Deve começar com uma barra (/). Nota Este parâmetro entra em vigor somente se você definir HealthCheckProtocol como HTTP.	/test/index.html
HealthCheckProtocol	string	Não	O protocolo usado para verificações de integridade. Valores válidos: TCP (padrão): o GWLB realiza verificações de integridade TCP enviando pacotes SYN a um servidor de backend para verificar se a porta do servidor de backend está disponível para receber solicitações. HTTP: o GWLB realiza verificações de integridade HTTP para verificar se os servidores de backend estão saudáveis, enviando solicitações GET que simulam o acesso de navegadores.	TCP
HealthyThreshold	integer	Não	O número de vezes que um servidor de backend não saudável deve passar consecutivamente nas verificações de integridade antes de ser declarado saudável. Nesse caso, o status da verificação de integridade do servidor de backend muda de fail para success. Valores válidos: 2 a 10. Valor padrão: 2.	2
UnhealthyThreshold	integer	Não	O número de vezes que um servidor de backend saudável deve falhar consecutivamente nas verificações de integridade antes de ser declarado não saudável. Nesse caso, o status da verificação de integridade do servidor de backend muda de success para fail. Valores válidos: 2 a 10. Valor padrão: 2.	2
HealthCheckReq	string	Não
HealthCheckExp	string	Não
Tag	array<object>	Não	As tags. Você pode especificar no máximo 20 tags em cada chamada.
	object	Não	A tag.
Key	string	Não	A chave da tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres e não pode começar com `acs:` ou `aliyun`. A chave da tag não pode conter `http://` ou `https://`.	testTagKey
Value	string	Não	O valor da tag. O valor da tag pode ter até 256 caracteres e não pode conter `http://` ou `https://`.	testTagValue
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run sem executar a solicitação real. Valores válidos: true: realiza apenas um dry run. O sistema verifica a solicitação em busca de possíveis problemas, incluindo valores de parâmetros ausentes, sintaxe de solicitação incorreta e limites de serviço. Se a solicitação falhar no dry run, um código de erro será retornado. Se a solicitação passar no dry run, o código de erro `DryRunOperation` será retornado. false (padrão): realiza um dry run e executa a solicitação real. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado e a operação será executada.	False
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja único entre diferentes solicitações. O token do cliente pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o ID da solicitação como o token do cliente. O ID da solicitação pode ser diferente para cada solicitação.	123e4567-e89b-12d3-a456-42665544****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	O ID do grupo de servidores.	sgp-atstuj3rtoptyui****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.	The health check protocol is invalid. Check the input parameters.
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The quota gwlb_quota_servergroups_num has exceeded the quota limit.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.
404	ResourceNotFound.Vpc	The specified resource of %s is not found.	The specified virtual private cloud resource does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.