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

Modifica as configurações de um grupo de servidores do Network Load Balancer (NLB).

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	UpdateServerGroupAttribute	A operação a ser executada. Defina o valor como UpdateServerGroupAttribute.
ServerGroupId	String	Sim	sgp-atstuj3rtoptyui****	O ID do grupo de servidores.
ServerGroupName	String	Não	NLB_ServerGroup1	O novo nome do grupo de servidores. O nome deve ter de 2 a 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra.
ConnectionDrainEnabled	Boolean	Não	false	Indica se o esgotamento de conexões está ativado. Valores válidos: true: ativa o esgotamento de conexões. false: desativa o esgotamento de conexões.
ConnectionDrainTimeout	Integer	Não	10	O tempo limite para o esgotamento de conexões. Unidade: segundos. Valores válidos: de 10 a 900.
Scheduler	String	Não	Wrr	O algoritmo de agendamento. Valores válidos: Wrr: servidores de back-end com pesos maiores recebem mais solicitações do que aqueles com pesos menores. rr: as solicitações são encaminhadas aos servidores de back-end sequencialmente. sch: solicitações do mesmo endereço IP de origem são encaminhadas ao mesmo servidor de back-end. tch: utiliza hash de quatro elementos. Este valor especifica um hash consistente baseado em quatro fatores: endereço IP de origem, endereço IP de destino, porta de origem e porta de destino. Solicitações com as mesmas informações nesses quatro fatores são encaminhadas ao mesmo servidor de back-end. qch: solicitações com o mesmo QUIC ID são encaminhadas ao mesmo servidor de back-end.
PreserveClientIpEnabled	Boolean	Não	false	Indica se a preservação do IP do cliente está ativada. Valores válidos: true: ativa a preservação do IP do cliente. false: desativa a preservação do IP do cliente.
HealthCheckConfig.HealthCheckEnabled	Boolean	Não	false	Indica se o recurso de verificação de integridade está ativado. Valores válidos: true: ativa o recurso de verificação de integridade. false: desativa o recurso de verificação de integridade.
HealthCheckConfig.HealthCheckType	String	Não	TCP	O protocolo usado para verificações de integridade. Valores válidos: TCP e HTTP.
HealthCheckConfig.HealthCheckConnectPort	Integer	Não	0	A porta de back-end usada para verificações de integridade. Valores válidos: de 0 a 65535. Se você definir o valor como 0, as portas dos servidores de back-end serão usadas para as verificações de integridade.
HealthCheckConfig.HealthyThreshold	Integer	Não	3	O número de vezes consecutivas que um servidor de back-end não íntegro deve passar nas verificações de integridade antes de ser considerado íntegro. Nesse caso, o status de integridade muda de fail para success. Valores válidos: de 2 a 10.
HealthCheckConfig.UnhealthyThreshold	Integer	Não	3	O número de vezes consecutivas que um servidor de back-end íntegro deve falhar nas verificações de integridade antes de ser considerado não íntegro. Nesse caso, o status de integridade muda de success para fail. Valores válidos: de 2 a 10.
HealthCheckConfig.HealthCheckConnectTimeout	Integer	Não	100	O tempo limite máximo para uma resposta de verificação de integridade. Unidade: segundos. Valores válidos: de 1 a 300.
HealthCheckConfig.HealthCheckInterval	Integer	Não	5	O intervalo entre duas verificações de integridade consecutivas. Unidade: segundos. Valores válidos: de 5 a 50.
HealthCheckConfig.HealthCheckDomain	String	Não	$SERVER_IP	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 específico. O nome de domínio deve ter de 1 a 80 caracteres e pode conter letras minúsculas, dígitos, hifens (-) e pontos (.). Nota Este parâmetro só tem efeito quando você define HealthCheckType como HTTP.
HealthCheckConfig.HealthCheckUrl	String	Não	/test/index.html	O caminho para o qual as solicitações de verificação de integridade são enviadas. O caminho deve ter de 1 a 80 caracteres e pode conter apenas letras, dígitos e os seguintes caracteres especiais: `- / . % ? # & =`. Também pode conter os seguintes caracteres estendidos: `_ ; ~ ! ( ) * [ ] @ $ ^ : ' , +`. O caminho deve começar com uma barra (/). Nota Este parâmetro só tem efeito quando você define HealthCheckType como HTTP.
HealthCheckConfig.HealthCheckHttpCode.N	String	Não	http_2xx	Os códigos de status HTTP a serem retornados para verificações de integridade. Separe vários códigos de status HTTP com vírgulas (,). Valores válidos: http_2xx (padrão), http_3xx, http_4xx e http_5xx. Nota Este parâmetro só tem efeito quando você define HealthCheckType como HTTP.
HealthCheckConfig.HttpCheckMethod	String	Não	GET	O método HTTP usado para verificações de integridade. Valores válidos: GET e HEAD. Nota Este parâmetro só tem efeito quando você define HealthCheckType como HTTP.
RegionId	String	Não	cn-hangzhou	O ID da região onde a instância NLB está implantada. Chame a operação DescribeRegions para consultar as regiões disponíveis.
DryRun	Boolean	Não	false	Indica se apenas a pré-verificação da solicitação deve ser realizada. Valores válidos: true: verifica a solicitação sem executar a operação UpdateServerGroupAttribute. O sistema verifica os parâmetros obrigatórios, a sintaxe da solicitação e os limites. Se a solicitação falhar na verificação, uma mensagem de erro será retornada. Se passar, o código de erro `DryRunOperation` será retornado. false (padrão): envia a solicitação. Se a solicitação passar na verificação, um código de status HTTP 2xx será retornado e a operação UpdateServerGroupAttribute será executada.
ClientToken	String	Não	123e4567-e89b-12d3-a456-426655440000	O token de cliente usado para garantir a idempotência da solicitação. Use o cliente para gerar o valor, mas garanta que ele seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema definirá automaticamente ClientToken com o valor de RequestId. O RequestId pode ser diferente para cada solicitação de API.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	54B48E3D-DF70-471B-AA93-08E683A1B45	O ID da solicitação.
ServerGroupId	String	sgp-atstuj3rtoptyui****	O ID do grupo de servidores.
JobId	String	72dcd26b-f12d-4c27-b3af-18f6aed5****	O ID da tarefa assíncrona.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=UpdateServerGroupAttribute
&ServerGroupId=sgp-atstuj3rtoptyui****
&ServerGroupName=NLB_ServerGroup1
&ConnectionDrainEnabled=false
&ConnectionDrainTimeout=10
&Scheduler=Wrr
&PreserveClientIpEnabled=false
&HealthCheckConfig={"HealthCheckEnabled":false,"HealthCheckType":"TCP","HealthCheckConnectPort":0,"HealthyThreshold":3,"UnhealthyThreshold":3,"HealthCheckConnectTimeout":100,"HealthCheckInterval":5,"HealthCheckDomain":"$SERVER_IP","HealthCheckUrl":"/test/index.html","HealthCheckHttpCode":["http_2xx"],"HttpCheckMethod":"GET"}
&RegionId=cn-hangzhou
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateServerGroupAttributeResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <ServerGroupId>sgp-atstuj3rtoptyui****</ServerGroupId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</UpdateServerGroupAttributeResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.