Todos os produtos
Search

Este produto

    :CreateServerGroup

    Central de documentação

    :CreateServerGroup

    Última atualização: Jul 03, 2026

    Cria um grupo de servidores para uma instância de Network Load Balancer (NLB).

    • O parâmetro protocol define o protocolo de encaminhamento das solicitações aos servidores de backend.

    • As instâncias NLB aceitam apenas grupos de servidores de backend com TCP, UDP ou SSL sobre TCP.

    • A operação CreateServerGroup é assíncrona. Após o envio da solicitação, o sistema retorna um ID de solicitação mesmo que a operação continue em execução em segundo plano. Para consultar o status de criação do grupo de servidores, chame a operação GetJobStatus.

      • Se a tarefa estiver com o status Succeeded, o grupo de servidores foi criado.

      • Se a tarefa estiver com o status Processing, o grupo de servidores está sendo criado.

    Depuração

    O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

    Parâmetros da solicitação

    ParâmetroTipoObrigatórioExemploDescrição
    ActionStringSimCreateServerGroup

    A operação a ser executada. Defina o valor como CreateServerGroup.

    ServerGroupTypeStringNãoInstance

    Tipo do grupo de servidores. Valores válidos:

    • Instance: permite adicionar servidores do tipo Ecs, Ens ou Eci. Este é o valor padrão.
    • IP: permite adicionar servidores por endereço IP.
    ServerGroupNameStringSimNLB_ServerGroup

    Nome do grupo de servidores.

    Deve ter entre 2 e 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra.

    AddressIPVersionStringNãoipv4

    Versão do protocolo. Valores válidos:

    • ipv4: IPv4. Este é o valor padrão.
    • DualStack: pilha dupla.
    ProtocolStringNãoTCP

    Protocolo de encaminhamento das solicitações aos servidores de backend. Valores válidos:

    • TCP: valor padrão.
    • UDP
    • TCPSSL
    VpcIdStringSimvpc-bp15zckdt37pq72zv****

    ID da VPC à qual o grupo de servidores pertence.

    Nota Se ServerGroupType for Instance, apenas servidores na VPC especificada poderão ser adicionados ao grupo.
    AnyPortEnabledBooleanNãofalse

    Indica se o encaminhamento de todas as portas está ativado. Valores válidos:

    • true: sim.
    • false: não. Valor padrão.
    ConnectionDrainEnabledBooleanNãofalse

    Indica se o esgotamento de conexão está ativado. Valores válidos:

    • true: sim.
    • false: não. Valor padrão.
    ConnectionDrainTimeoutIntegerNão10

    Tempo limite do esgotamento de conexão. Unidade: segundos.

    Valores válidos: de 10 a 900.

    SchedulerStringNãoWrr

    Algoritmo de agendamento. Valores válidos:

    • Wrr: round-robin ponderado. Servidores de backend com pesos maiores recebem mais solicitações. Valor padrão.
    • rr: round-robin. Encaminha as solicitações sequencialmente aos servidores de backend.
    • sch: hash de IP de origem. Encaminha solicitações do mesmo IP de origem para o mesmo servidor de backend.
    • tch: hash de quatro elementos. Hash consistente baseado em IP de origem, IP de destino, porta de origem e porta de destino. Solicitações com os mesmos valores nesses quatro fatores vão para o mesmo servidor de backend.
    • qch: hash de QUIC ID. Encaminha solicitações com o mesmo QUIC ID para o mesmo servidor de backend.
    PreserveClientIpEnabledBooleanNãofalse

    Indica se a preservação do IP do cliente está ativada. Valores válidos:

    • true: sim.
    • false: não. Valor padrão.
    HealthCheckConfig.HealthCheckEnabledBooleanNãotrue

    Indica se a verificação de integridade está ativada. Valores válidos:

    • true: sim. Valor padrão.
    • false: não.
    HealthCheckConfig.HealthCheckTypeStringNãoTCP

    Protocolo da verificação de integridade. Valores válidos: TCP (padrão) e HTTP.

    HealthCheckConfig.HealthCheckConnectPortIntegerNão0

    Porta de backend usada na verificação de integridade.

    Valores válidos: de 0 a 65535.

    Valor padrão: 0. Se definido como 0, usa-se a porta do servidor de backend para as verificações.

    HealthCheckConfig.HealthyThresholdIntegerNão2

    Número de verificações de integridade consecutivas com sucesso necessárias para alterar o status de um servidor de backend de fail para success.

    Valores válidos: de 2 a 10.

    Valor padrão: 2.

    HealthCheckConfig.UnhealthyThresholdIntegerNão2

    Número de verificações de integridade consecutivas com falha necessárias para alterar o status de um servidor de backend de success para fail.

    Valores válidos: de 2 a 10.

    Valor padrão: 2.

    HealthCheckConfig.HealthCheckConnectTimeoutIntegerNão5

    Tempo limite máximo de resposta da verificação de integridade. Unidade: segundos.

    Valores válidos: de 1 a 300.

    Valor padrão: 5.

    HealthCheckConfig.HealthCheckIntervalIntegerNão10

    Intervalo entre duas verificações de integridade consecutivas. Unidade: segundos.

    Valores válidos: de 5 a 50.

    Valor padrão: 10.

    HealthCheckConfig.HealthCheckDomainStringNão$SERVER_IP

    Nome de domínio usado na verificação de integridade. Valores válidos:

    • $SERVER_IP: endereço IP privado do servidor de backend.
    • domain: nome de domínio personalizado para as verificações. Deve ter entre 1 e 80 caracteres e pode conter letras minúsculas, dígitos, hifens (-) e pontos (.).
    Nota Este parâmetro só tem efeito quando HealthCheckType é HTTP.
    HealthCheckConfig.HealthCheckUrlStringNão/test/index.html

    Caminho de destino das solicitações de verificação de integridade.

    Deve ter entre 1 e 80 caracteres e pode conter apenas letras, dígitos e os seguintes caracteres especiais: - / . % ? # & =. Também aceita estes caracteres estendidos: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , +. Deve começar com uma barra (/).

    Nota Este parâmetro só tem efeito quando HealthCheckType é HTTP.
    HealthCheckConfig.HealthCheckHttpCode.NStringNãohttp_2xx

    Códigos de status HTTP considerados saudáveis nas verificações de integridade. Separe vários códigos 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 HealthCheckType é HTTP.
    HealthCheckConfig.HttpCheckMethodStringNãoGET

    Método HTTP da verificação de integridade. Valores válidos: GET (padrão) e HEAD.

    Nota Este parâmetro só tem efeito quando HealthCheckType é HTTP.
    ResourceGroupIdStringNãorg-atstuj3rtop****

    ID do grupo de recursos ao qual o grupo de servidores pertence.

    DryRunBooleanNãotrue

    Indica se deve haver uma execução simulada. Valores válidos:

    • true: execute a simulação. O sistema valida os parâmetros obrigatórios, a sintaxe da solicitação e os limites. Se a validação falhar, retorna uma mensagem de erro. Se passar, retorna o código de erro DryRunOperation.
    • false: execute a simulação e envie a solicitação. Se a validação passar, retorna um código de status HTTP 2xx e execute a operação.
    ClientTokenStringNão123e4567-e89b-12d3-a456-426655440000

    Token de cliente para garantir a idempotência da solicitação.

    Gere o valor no cliente, garantindo que seja único entre diferentes solicitações. O token aceita apenas caracteres ASCII.

    Nota Se este parâmetro não for definido, o sistema usará automaticamente o valor de RequestId como ClientToken. O valor de RequestId pode variar a cada solicitação de API.
    RegionIdStringNãocn-hangzhou

    ID da região onde a instância NLB está implantada.

    Para obter a lista mais recente de regiões, chame a operação DescribeRegions.

    Parâmetros de resposta

    Parâmetro

    Tipo

    Exemplo

    Descrição

    RequestId

    String

    54B48E3D-DF70-471B-AA93-08E683A1B45

    ID da solicitação.

    ServerGroupId

    String

    sgp-atstuj3rtoptyui****

    ID do grupo de servidores.

    JobId

    String

    72dcd26b-f12d-4c27-b3af-18f6aed5****

    ID da tarefa assíncrona.

    Exemplos

    Exemplos de solicitações

    http(s)://[Endpoint]/?Action=CreateServerGroup
&ServerGroupType=Instance
&ServerGroupName=NLB_ServerGroup
&AddressIPVersion=ipv4
&Protocol=TCP
&VpcId=vpc-bp15zckdt37pq72zv****
&AnyPortEnabled=false
&ConnectionDrainEnabled=false
&ConnectionDrainTimeout=10
&Scheduler=Wrr
&PreserveClientIpEnabled=false
&HealthCheckConfig={"HealthCheckEnabled":true,"HealthCheckType":"TCP","HealthCheckConnectPort":0,"HealthyThreshold":2,"UnhealthyThreshold":2,"HealthCheckConnectTimeout":5,"HealthCheckInterval":10,"HealthCheckDomain":"$SERVER_IP","HealthCheckUrl":"/test/index.html","HealthCheckHttpCode":["http_2xx"],"HttpCheckMethod":"GET"}
&ResourceGroupId=rg-atstuj3rtop****
&DryRun=true
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&Common request parameters

    Exemplos de respostas de sucesso

    Formato XML

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

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

    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.