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

Atualiza os atributos de um grupo de servidores do Server Load Balancer.

Descrição da operação

UpdateServerGroupAttribute é 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. A configuração do grupo de servidores não é atualizada imediatamente. Você pode chamar a operação ListServerGroups para consultar o status do grupo de servidores.

Se um grupo de servidores estiver no estado Configuring, sua configuração está sendo atualizada.
Se um grupo de servidores estiver no estado Available, sua configuração está atualizada.

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

update

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ServerGroupId	string	Sim	O ID do grupo de servidores.	sgp-atstuj3rtoptyui****
ServerGroupName	string	Não	O nome do grupo de servidores. O nome deve ter de 2 a 128 caracteres, começar com uma letra ou um caractere chinês e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-).	testServerGroupName
Scheduler	string	Não	O algoritmo de agendamento. Valores válidos: 5TCH: hash de 5 tuplas. Os pacotes são distribuídos para os servidores de back-end com base em um hash de 5 tuplas do endereço IP de origem, endereço IP de destino, porta de origem, porta de destino e protocolo. Isso garante que o mesmo fluxo seja sempre agendado para o mesmo servidor de back-end. 3TCH: hash de 3 tuplas. Os pacotes são distribuídos para os servidores de back-end com base em um hash de 3 tuplas do endereço IP de origem, endereço IP de destino e protocolo. Isso garante que o mesmo fluxo seja sempre agendado para o mesmo servidor de back-end. 2TCH: hash de 2 tuplas. Os pacotes são distribuídos para os servidores de back-end com base em um hash de 2 tuplas do endereço IP de origem e endereço IP de destino. Isso garante que o mesmo fluxo seja sempre agendado para o mesmo servidor de back-end.	5TCH
ServerFailoverMode	string	Não	O método usado para lidar com conexões existentes quando um servidor de back-end apresenta exceção. Valores válidos: NoRebalance: As conexões existentes não são rebalanceadas. Rebalance: As conexões existentes são rebalanceadas.	NoRebalance
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 tempo limite da drenagem de conexão. Unidade: segundos. Valores válidos: 1 a 3600.	300
HealthCheckConfig	object	Não	As configurações de verificações de integridade.
HealthCheckConnectPort	integer	Não	A porta usada para verificações de integridade nos servidores de back-end. Valores válidos: 1 a 65535.	80
HealthCheckConnectTimeout	integer	Não	O período máximo de tempo limite de uma resposta de verificação de integridade. Unidade: segundos. Valores válidos: 1 a 300.	5
HealthCheckDomain	string	Não	O nome de domínio usado para verificações de integridade. Valores válidos: $SERVER_IP: o endereço IP privado de um servidor de back-end. domain: um nome de domínio especificado. O nome de domínio deve ter de 1 a 80 caracteres e pode conter letras, dígitos, hifens (-) e pontos (.). Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	Não	Especifica se as verificações de integridade devem ser ativadas. Valores válidos: true false	true
HealthCheckHttpCode	array	Não	A lista de códigos de status HTTP que indicam um estado íntegro.
	string	Não	O código de status HTTP que indica um estado íntegro. Você pode especificar vários códigos de status HTTP. Separe vários códigos de status com vírgulas (,). Valores válidos: http_2xx: Um código de status HTTP 2xx indica um estado íntegro. http_3xx: Um código de status HTTP 3xx indica um estado íntegro. http_4xx: Um código de status HTTP 4xx indica um estado íntegro. http_5xx: Um código de status HTTP 5xx indica um estado íntegro. Valor padrão: http_2xx. Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido 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.	10
HealthCheckPath	string	Não	O caminho usado para verificações de integridade. O caminho deve ter de 1 a 80 caracteres e pode conter letras, dígitos e os seguintes caracteres especiais: `-/.%?#&`. Deve começar com uma barra (/). Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP.	/test/index.html
HealthCheckProtocol	string	Não	O protocolo usado para verificações de integridade. Valores válidos: TCP: Pacotes TCP SYN são enviados para um servidor de back-end para verificar se a porta do servidor de back-end está acessível. HTTP: Solicitações GET são enviadas para um servidor de back-end para verificar se o aplicativo do servidor está íntegro.	TCP
HealthyThreshold	integer	Não	O número de verificações de integridade bem-sucedidas consecutivas necessárias para alterar o status de verificação de integridade de um servidor de back-end de failed para successful. Valores válidos: 2 a 10.	2
UnhealthyThreshold	integer	Não	O número de verificações de integridade com falha consecutivas necessárias para alterar o status de verificação de integridade de um servidor de back-end de successful para failed. Valores válidos: 2 a 10.	2
HealthCheckReq	string	Não
HealthCheckExp	string	Não
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: realiza um dry run. O sistema verifica os parâmetros obrigatórios, o formato da solicitação e os limites do serviço. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro `DryRunOperation` será retornado. false (padrão): realiza um dry run e envia a solicitação. 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 de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar um token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação como o ClientToken. O RequestId pode ser diferente para cada solicitação.	123e4567-e89b-12d3-a456-42665544****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
RequestId	string	O ID da solicitação.	54B48E3D-DF70-471B-AA93-08E683A1B45

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45\n"
}

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	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	OperationDenied.SchedulerNotConfigurable	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	The specified server group 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.