Todos os produtos
Search
Central de documentação

Server Load Balancer:CreateServerGroup

Última atualização: Oct 09, 2026

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

Descrição da operação

A operação CreateServerGroup é assíncrona. O sistema retorna um ID de solicitação, mas o grupo de servidores do Network Load Balancer (NLB) ainda não foi criado, e a tarefa de criação ainda está em execução em segundo plano. Você pode chamar a operação GetJobStatus para consultar o status de criação do grupo de servidores:\n - Se o status da tarefa for Succeeded, o grupo de servidores foi criado.\n - Se o status da tarefa for Processing, o grupo de servidores está sendo criado. Nesse estado, você pode realizar apenas operações de consulta e não pode realizar outras operações.

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

nlb:CreateServerGroup

create

*ServerGroup.

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

*VPC.

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

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

ServerGroupType

string

Não

O tipo de grupo de servidores. Valores válidos:\n\n- Instance (padrão): tipo de servidor. Este tipo de grupo de servidores oferece suporte à adição de instâncias Ecs, Eni e Eci.\n\n- Ip: tipo de endereço IP. Este tipo de grupo de servidores oferece suporte à adição direta de servidores de backend por endereço IP.

Instance

ServerGroupName

string

Sim

O nome do grupo de servidores.\n\nO nome deve ter de 2 a 128 caracteres e deve começar com uma letra ou caractere chinês. Pode conter dígitos, pontos (.), sublinhados (_) e hifens (-).

NLB_ServerGroup

AddressIPVersion

string

Não

A versão do protocolo. Valores válidos:\n\n- ipv4 (padrão): IPv4.\n\n- DualStack: pilha dupla.

ipv4

IpVersionAffinityMode

string

Não

A política de agendamento de tráfego no modo de pilha dupla. Valores válidos:\n\n- NonAffinity (padrão): modo de não afinidade. O tráfego é encaminhado para servidores de backend íntegros com base no algoritmo de agendamento, independentemente da versão do protocolo IP da origem.\n- Affinity: modo de afinidade. O tráfego é encaminhado com base na versão do protocolo IP da origem da solicitação. As solicitações IPv4 são encaminhadas apenas para servidores de backend IPv4, e as solicitações IPv6 são encaminhadas apenas para servidores de backend IPv6.\n> Este parâmetro entra em vigor apenas quando AddressIPVersion é definido como DualStack.

Affinity

Protocol

string

Não

O protocolo de comunicação usado para encaminhar tráfego para servidores de backend. Valores válidos:\n\n- TCP (padrão)\n- UDP\n- TCP_UDP\n> \n> - Se este parâmetro for definido como UDP, o grupo de servidores poderá ser associado apenas a listeners UDP.\n> - Se este parâmetro for definido como TCP e PreserveClientIpEnabled for definido como true, o grupo de servidores poderá ser associado apenas a listeners TCP.\n> - Se este parâmetro for definido como TCP e PreserveClientIpEnabled for definido como false, o grupo de servidores poderá ser associado a listeners TCPSSL e TCP.\n> - Se este parâmetro for definido como TCP_UDP, o grupo de servidores poderá ser associado a listeners TCP e UDP.

TCP

VpcId

string

Sim

O ID da VPC onde o grupo de servidores está implantado.\n\n> Se ServerGroupType for definido como Instance, apenas servidores nesta VPC poderão ser adicionados ao grupo de servidores.

vpc-bp15zckdt37pq72zv****

AnyPortEnabled

boolean

Não

Especifica se o encaminhamento de todas as portas deve ser ativado. Valores válidos:\n\n- true: ativa o encaminhamento de todas as portas.\n\n- false (padrão): desativa o encaminhamento de todas as portas.

false

ConnectionDrainEnabled

boolean

Não

Especifica se a drenagem de conexão deve ser ativada. Valores válidos:\n\n- true: ativa a drenagem de conexão.\n\n- false (padrão): desativa a drenagem de conexão.

false

ConnectionDrainTimeout

integer

Não

O período de tempo limite para drenagem de conexão. Unidade: segundos.\nValores válidos: 0 a 900.

10

Scheduler

string

Não

O algoritmo de agendamento. Valores válidos:\n\n- Wrr (padrão): round-robin ponderado. Servidores de backend com pesos maiores têm maior probabilidade de serem consultados.\n\n- Wlc: menor número de conexões ponderado. Além do peso de cada servidor de backend, a carga real (número de conexões) do servidor de backend também é considerada. Se os pesos forem iguais, os servidores de backend com menos conexões atuais têm maior probabilidade de serem consultados.\n\n- rr: round-robin. As solicitações externas são distribuídas para os servidores de backend em sequência.\n\n- sch: hash de IP de origem. As solicitações do mesmo endereço IP de origem são agendadas para o mesmo servidor de backend.\n\n- tch: hash de 4 tuplas. Hash consistente com base na 4-tupla (endereço IP de origem, endereço IP de destino, porta de origem e porta de destino). As solicitações do mesmo fluxo são agendadas para o mesmo servidor de backend.\n\n- qch: hash de ID QUIC. As solicitações com o mesmo ID QUIC são agendadas para o mesmo servidor de backend.\n\n> O hash de ID QUIC é suportado apenas quando o protocolo de backend é UDP.

Wrr

PreserveClientIpEnabled

boolean

Não

Especifica se a preservação do endereço IP do cliente deve ser ativada. Valores válidos:\n\n- true (padrão): ativa a preservação do endereço IP do cliente.\n- false: desativa a preservação do endereço IP do cliente.\n\n\n> \n> Se Protocol for definido como TCP e este parâmetro for definido como true, o grupo de servidores não poderá ser associado a listeners TCPSSL.

true

HealthCheckConfig

object

Não

A configuração de verificação de integridade.

HealthCheckConnectPort

integer

Não

A porta do servidor de backend usada para verificações de integridade.\n\nValores válidos: 0 a 65535.\n\nValor padrão: 0. Este valor indica que a porta do servidor de backend é usada para verificações de integridade.

0

HealthCheckConnectTimeout

integer

Não

O período máximo de tempo limite para uma resposta de verificação de integridade. Unidade: segundos.\nValores válidos: 1 a 300.\nValor padrão: 5.

5

HealthCheckDomain

string

Não

O nome de domínio usado para verificações de integridade. Valores válidos:\n\n- $SERVER_IP: o endereço IP interno do servidor de backend.\n\n- domain: um nome de domínio especificado. O nome de domínio deve ter de 1 a 80 caracteres e pode conter apenas letras, dígitos, hifens (-) e pontos (.).\n\n> Este parâmetro entra em vigor apenas quando HealthCheckType é definido como HTTP.

$SERVER_IP

HealthCheckEnabled

boolean

Não

Especifica se as verificações de integridade devem ser ativadas. Valores válidos:\n\n- true (padrão): ativa as verificações de integridade.\n\n- false: desativa as verificações de integridade.

true

HealthCheckExp

string

Não

A string de consulta na solicitação para verificações de integridade de listener UDP. A string pode conter apenas letras e dígitos e pode ter até 512 caracteres.

ok

HealthCheckHttpCode

array

Não

Os códigos de status HTTP para respostas íntegras. Separe vários códigos de status com vírgulas (,).\nValores válidos: http_2xx (padrão), http_3xx, http_4xx e http_5xx.\n> Este parâmetro entra em vigor apenas quando HealthCheckType é definido como HTTP.

string

Não

Os códigos de status HTTP para respostas íntegras. Separe vários códigos de status com vírgulas (,).\nValores válidos: http_2xx (padrão), http_3xx, http_4xx e http_5xx.\n> Este parâmetro entra em vigor apenas quando HealthCheckType é definido como HTTP.

http_2xx

HealthCheckHttpVersion

string

Não

A versão do protocolo HTTP para verificações de integridade. Valores válidos: HTTP1.0 (padrão) e HTTP1.1.\n\n> Este parâmetro entra em vigor apenas quando HealthCheckType é definido como HTTP.

HTTP1.0

HealthCheckInterval

integer

Não

O intervalo entre duas verificações de integridade consecutivas. Unidade: segundos. Valor padrão: 5.\n\n- Se HealthCheckType for definido como TCP ou HTTP, os valores válidos são 1 a 50.\n- Se HealthCheckType for definido como UDP, os valores válidos são 1 a 300. Você deve definir o intervalo como maior ou igual ao período de tempo limite de resposta para garantir que as respostas de sondagem UDP não sejam julgadas incorretamente como sem resposta devido a um tempo limite.

5

HealthCheckReq

string

Não

A string de consulta na solicitação para verificações de integridade de listener UDP. A string pode conter apenas letras e dígitos e pode ter até 512 caracteres.

hello

HealthCheckType

string

Não

O protocolo usado para verificações de integridade. Valores válidos:\n\n- TCP\n- HTTP\n- UDP

TCP

HealthCheckUrl

string

Não

O caminho de verificação de integridade.\n\nO caminho deve ter de 1 a 80 caracteres e pode conter apenas letras, dígitos e os seguintes caracteres especiais: -/.%?#&. Deve começar com uma barra (/).\n> Este parâmetro entra em vigor apenas quando HealthCheckType é definido como HTTP.

/test/index.html

HealthyThreshold

integer

Não

O número de verificações de integridade bem-sucedidas consecutivas que devem ocorrer antes que o status de verificação de integridade de um servidor de backend seja alterado de fail para success.\n\nValores válidos: 2 a 10.\n\nValor padrão: 2.

2

HttpCheckMethod

string

Não

O método HTTP usado para verificações de integridade. Valores válidos: GET (padrão) e HEAD.\n> Este parâmetro entra em vigor apenas quando HealthCheckType é definido como HTTP.

GET

UnhealthyThreshold

integer

Não

O número de verificações de integridade com falha consecutivas que devem ocorrer antes que o status de verificação de integridade de um servidor de backend seja alterado de success para fail.\n\nValores válidos: 2 a 10.\n\nValor padrão: 2.

2

ResourceGroupId

string

Não

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

rg-atstuj3rtop****

DryRun

boolean

Não

Especifica se apenas a pré-verificação da solicitação deve ser realizada. Valores válidos:\n- true: realiza a pré-verificação da solicitação sem criar o grupo de servidores. O sistema verifica se os parâmetros obrigatórios foram especificados, o formato da solicitação e os limites do serviço. Se a solicitação falhar na pré-verificação, o erro correspondente será retornado. Se a solicitação passar na pré-verificação, o código de erro DryRunOperation será retornado.\n- false (padrão): envia a solicitação. Se a solicitação passar na pré-verificação, um código de status HTTP 2xx será retornado e a operação será executada.

true

ClientToken

string

Não

O token de cliente usado para garantir a idempotência da solicitação.\n\nVocê pode usar o cliente para gerar o valor, mas deve garantir que ele seja exclusivo entre diferentes solicitações. O token de cliente pode conter apenas caracteres ASCII.\n\n> Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como o ClientToken. O RequestId de cada solicitação de API é exclusivo.

123e4567-e89b-12d3-a456-426655440000

RegionId

string

Não

O ID da região da instância do Network Load Balancer (NLB). \n\nVocê pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.

cn-hangzhou

Tag

array<object>

Não

A lista de tags.

object

Não

A tag.

Key

string

Não

A chave da tag. A chave da tag pode ter até 64 caracteres e não pode começar com aliyun ou acs:. Não pode conter http:// ou https://. Pode conter letras, dígitos, sublinhados (_), pontos (.), dois-pontos (:), barras (/), sinais de igual (=), sinais de mais (+), hifens (-) e arrobas (@).\n\nVocê pode adicionar até 20 tags em uma única chamada.

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:. Não pode conter http:// ou https://. Pode conter letras, dígitos, sublinhados (_), pontos (.), dois-pontos (:), barras (/), sinais de igual (=), sinais de mais (+), hifens (-) e arrobas (@).\n\nVocê pode adicionar até 20 tags em uma única chamada.

product

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O grupo de servidores.

JobId

string

O ID da tarefa assíncrona.

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

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

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "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.AnyPortServerGroupConflictWithHealthCheckConfig The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal. A configuração do grupo de servidores entra em conflito com as configurações de verificação de integridade. Verifique os parâmetros de configuração.
400 IllegalParamFormat.ParseCreateRsPoolRequestFailed The param format of CreateRsPoolRequest is illegal. O formato do parâmetro de CreateRsPoolRequestFailed é inválido. Consulte a referência da API para verificar os parâmetros da solicitação.
400 IllegalParam.PreserveClientIpSwitch The param of PreserveClientIpSwitch is illegal.
400 OperationDenied.VpcNotSupportIpv6 The operation is not allowed because of VpcNotSupportIpv6. A VPC especificada não suporta IPv6.
400 IllegalParam.healthCheckDomain The parameter of healthCheckConfig.healthCheckDomain is illegal. O healthCheckDomain na configuração de verificação de integridade é inválido. Verifique os parâmetros de entrada.
400 OperationDenied.UidNotAllowQuic29 The operation is not allowed because of uid not allow quic29 version.
400 IlleagalParam.healthCheckUrl The parameter of healthCheckUrl in healthCheckConfig is illegal. A URL de verificação de integridade usada nas configurações de verificação de integridade é inválida.
400 IllegalParam.ServerGroupName The param of ServerGroupName is illegal. O parâmetro ServerGroupName é inválido.
400 DryRunOperation Request validation has been passed with DryRun flag set. A solicitação DryRun passou na validação.
400 MissingParam.%s The parameter of %s is missing. O parâmetro %s está ausente. Verifique os parâmetros de entrada.
400 IllegalParam.ConnectionDrainTimeout The param of ConnectionDrainTimeout is illegal. O parâmetro ConnectionDrainTimeout é inválido. Verifique os parâmetros de entrada.
400 IllegalParam The param of %s is illegal. Os parâmetros de entrada contêm valores inválidos. Verifique a entrada.
400 SystemBusy System is busy, please try again later. O sistema está ocupado. Tente novamente mais tarde.
400 QuotaExceeded.QuotaInsufficient The quota of %s is exceeded, usage %s/%s. A cota é insuficiente. Utilizado: %s/%s. Modifique a cota no Quota Center.
403 Forbidden.NoPermission Authentication is failed for NoPermission. Falha na autenticação porque a conta não tem as permissões necessárias.
404 ResourceNotFound.Vpc The specified resource of Vpc is not found. O recurso da VPC especificada não pode ser encontrado. Verifique os parâmetros de entrada.
404 ResourceNotFound.ResourceGroup The param of resourceGroup not existed. O grupo de recursos 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.