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

Consulta grupos de servidores.

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

alb:ListServerGroups

get

*ServerGroup.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ServerGroupIds	array	Não	A lista de IDs de grupos de servidores.
	string	Não	O ID do grupo de servidores. Você pode especificar até 20 IDs de grupos de servidores em uma única solicitação.	sgp-atstuj3rtop****
ServerGroupNames	array	Não	A lista de nomes de grupos de servidores. Você pode especificar até 10 nomes de grupos de servidores.
	string	Não	O nome do grupo de servidores. Você pode especificar até 10 nomes de grupos de servidores em uma única solicitação.	Group3
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-atstuj3rtop****
NextToken	string	Não	O token usado para recuperar a próxima página de resultados. Valores válidos: Para a primeira solicitação ou quando nenhuma solicitação subsequente for necessária, deixe este parâmetro vazio. Para uma solicitação subsequente, defina este parâmetro com o valor NextToken retornado da chamada de API anterior.	FFmyTO70tTpLG6I3FmYAXG****
MaxResults	integer	Não	O número máximo de entradas a serem retornadas para uma única solicitação. Valores válidos: 1 a 100. Valor padrão: 20.	20
VpcId	string	Não	O ID da instância conectada à VPC.	vpc-bp15zckdt37pq72zv****
ServerGroupType	string	Não	O tipo de grupo de servidores. Valores válidos: Instance: o tipo de servidor, que inclui instâncias ECS, ENI e ECI. Ip: o tipo de endereço IP. Fc: o tipo Function Compute. Se você deixar este parâmetro vazio, todos os tipos serão consultados.	Instance
Tag	array<object>	Não	A lista de tags adicionadas ao grupo de servidores. Você pode especificar até 10 tags em uma única solicitação.	Instance
	object	Não	A tag adicionada ao grupo de servidores. Você pode especificar até 10 tags em uma única solicitação.
Key	string	Não	A chave da tag. Você pode especificar até 10 chaves de tag. A chave pode ter até 64 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	Test
Value	string	Não	O valor da tag. Você pode especificar até 10 valores de tag. O valor pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	Test

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura de dados da resposta.
MaxResults	integer	O número de entradas retornadas por solicitação em uma consulta paginada.	50
NextToken	string	O token usado para recuperar a próxima página de resultados. Valores válidos:\n- Se NextToken estiver vazio, não há mais resultados disponíveis.\n- Se NextToken for retornado, o valor é o token para a próxima consulta.	caeba0bbb2be03f8****
RequestId	string	O ID da solicitação.	CEF72CEB-54B6-4AE8-B225-F876******
ServerGroups	array<object>	A lista de grupos de servidores de back-end.
	array<object>	A lista de grupos de servidores de back-end.
HealthCheckConfig	object	A configuração de verificação de integridade.
HealthCheckConnectPort	integer	A porta do servidor de back-end usada para verificações de integridade. Valores válidos: 0 a 65535. O valor 0 indica que a porta do servidor de back-end é usada para verificações de integridade.	80
HealthCheckEnabled	boolean	Indica se as verificações de integridade estão ativadas. Valores válidos:\n- true: Ativado.\n- false: Desativado.	true
HealthCheckHost	string	O nome de domínio usado para verificações de integridade.\n\n- Usar o endereço IP interno do servidor de back-end (padrão): O endereço IP interno do servidor de back-end é usado como o nome de domínio para verificações de integridade.\n\n- Especificar um nome de domínio: Insira um nome de domínio.\n\n - O nome de domínio deve ter de 1 a 80 caracteres.\n\n - Pode conter letras minúsculas, dígitos, hifens (-) e pontos (.).\n\n - Deve conter pelo menos um ponto (.), e o ponto (.) não pode estar no início ou no fim.\n\n - O rótulo de domínio mais à direita pode conter apenas letras e não pode conter dígitos ou hifens (-).\n\n - Um hífen (-) não pode estar no início ou no fim.\n\n> \n> Este parâmetro só entra em vigor quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	www.example.com
HealthCheckCodes	array	A lista de códigos de status que indicam uma verificação de integridade bem-sucedida.
	string	O código de status que indica uma verificação de integridade bem-sucedida.\n\n- Quando HealthCheckProtocol está definido como HTTP ou HTTPS, os valores válidos para HealthCheckCodes são http_2xx, http_3xx, http_4xx e http_5xx. Separe vários códigos de status com vírgulas (,).\n\n- Quando HealthCheckProtocol está definido como gRPC, os valores válidos para HealthCheckCodes variam de 0 a 99. Você pode especificar intervalos. Há suporte para no máximo 20 intervalos. Separe vários intervalos com vírgulas (,).\n\n> Este parâmetro só entra em vigor quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	http_2xx
HealthCheckHttpVersion	string	A versão HTTP para verificações de integridade. Valores válidos: HTTP1.0 e HTTP1.1.\n\n> Este parâmetro só entra em vigor quando HealthCheckProtocol está definido como HTTP ou HTTPS.	HTTP1.1
HealthCheckInterval	integer	O intervalo entre duas verificações de integridade consecutivas. Unidade: segundos. Valores válidos: 1 a 50.	5
HealthCheckMethod	string	O método HTTP usado para verificações de integridade. Valores válidos:\n\n- GET: Se a mensagem de resposta exceder 8 KB, ela será truncada. No entanto, isso não afeta o resultado da verificação de integridade.\n\n- POST: O método POST é usado por padrão para verificações de integridade de listener gRPC.\n\n- HEAD: O método HEAD é usado por padrão para verificações de integridade de listener HTTP e HTTPS.\n\n\n> Este parâmetro só entra em vigor quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	HEAD
HealthCheckPath	string	O caminho usado para verificações de integridade.\n\n> Este parâmetro só entra em vigor quando HealthCheckProtocol está definido como HTTP ou HTTPS.	/test/index.html
HealthCheckProtocol	string	O protocolo usado para verificações de integridade. Valores válidos:\n\n- HTTP: Envia solicitações HEAD ou GET para simulação de navegador a fim de verificar se a aplicação do servidor está íntegra.\n\n- HTTPS: Envia solicitações HEAD ou GET para simulação de navegador a fim de verificar se a aplicação do servidor está íntegra. (Criptografia de dados, mais seguro que HTTP.)\n\n- TCP: Envia mensagens de handshake SYN para verificar se a porta do servidor está ativa.\n\n- gRPC: Envia solicitações POST ou GET para verificar se a aplicação do servidor está íntegra.	HTTP
HealthCheckTimeout	integer	O período de tempo limite para uma resposta de verificação de integridade. Se o servidor de back-end não responder dentro do período de tempo limite especificado, a verificação de integridade falhará. Unidade: segundos.	3
HealthyThreshold	integer	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.	4
UnhealthyThreshold	integer	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.	4
Protocol	string	O tipo de protocolo de back-end. Valores válidos:\n\n- HTTP: Suporta associação com listeners HTTPS, HTTP e QUIC.\n- HTTPS: Suporta associação com listeners HTTPS.\n\n- GRPC: Suporta associação com listeners HTTPS e QUIC.	HTTP
RelatedLoadBalancerIds	array	Os IDs das instâncias associadas.
	string	O ID da instância de load balancer associada.	alb-n5qw04uq8savfe****
ResourceGroupId	string	O ID do grupo de recursos.	rg-atstuj3rtop****
Scheduler	string	O algoritmo de agendamento. Valores válidos:\n\n- Wrr: Round-robin ponderado. Servidores de back-end com pesos maiores têm maior probabilidade de serem sondados.\n- Wlc: Menos conexões ponderadas. Além do peso de cada servidor de back-end, a carga real (número de conexões) também é considerada. Quando os pesos são iguais, os servidores de back-end com menos conexões atuais têm maior probabilidade de serem sondados.\n- Sch: Hashing consistente. Solicitações com o mesmo resultado de cálculo do fator de hash são agendadas para o mesmo servidor de back-end. Se o parâmetro UchConfig não estiver configurado, o fator de hash padrão é o endereço IP de origem, e as solicitações do mesmo endereço IP de origem são distribuídas para o mesmo servidor de back-end. Se o parâmetro UchConfig estiver configurado, o fator de hash é o parâmetro de URL, e as solicitações com o mesmo parâmetro de URL são distribuídas para o mesmo servidor de back-end.	Wrr
ServerGroupId	string	O ID do grupo de servidores.	sgp-cige6j****
ServerGroupName	string	O nome do grupo de servidores.	Group3
ServerGroupStatus	string	O status do grupo de servidores. Valores válidos:\n- Creating: O grupo de servidores está sendo criado.\n\n- Available: O grupo de servidores está disponível.\n\n- Configuring: O grupo de servidores está sendo reconfigurado.	Available
ServerGroupType	string	O tipo do grupo de servidores. Valores válidos:\n\n- Instance: Tipo de servidor, incluindo instâncias ECS, ENI e ECI.\n\n- Ip: Tipo de endereço IP.\n\n- Fc: Tipo de Function Compute.	Instance
StickySessionConfig	object	A configuração de persistência de sessão.
Cookie	string	O cookie configurado no servidor.	B490B5EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	O período de tempo limite do cookie. Unidade: segundos. Valores válidos: 1 a 86400.\n\n> Este parâmetro só entra em vigor quando StickySessionEnabled está definido como true e StickySessionType está definido como Insert.	1000
StickySessionEnabled	boolean	Indica se a persistência de sessão está ativada. Valores válidos:\n\n- true: Ativado.\n- false: Desativado.	false
StickySessionType	string	O método usado para lidar com cookies. Valores válidos:\n\n- Insert: Inserir um cookie. Quando um cliente acessa o serviço pela primeira vez, o load balancer insere um cookie (ou seja, insere SERVERID na mensagem de resposta HTTP ou HTTPS). Na próxima vez que o cliente acessar o serviço com esse cookie, o serviço de load balancer encaminhará a solicitação para o servidor de back-end registrado anteriormente.\n- Server: Reescrever um cookie. Quando o load balancer detecta um cookie definido pelo usuário, ele reescreve o cookie original. Na próxima vez que o cliente acessar o serviço com o novo cookie, o serviço de load balancer encaminhará a solicitação para o servidor de back-end registrado anteriormente.	Insert
VpcId	string	O ID da instância conectada à VPC.	vpc-bp15zckdt37pq72zv****
Tags	array<object>	A lista de tags vinculadas ao grupo de servidores.
	object	A lista de tags vinculadas ao grupo de servidores.
Key	string	A chave da tag.	Test
Value	string	O valor da tag.	Test
ConfigManagedEnabled	boolean	Indica se o gerenciamento de configuração está ativado. Valores válidos:\n- true: Ativado.\n- false: Desativado.	false
UpstreamKeepaliveEnabled	boolean	Indica se o keep-alive upstream está ativado. Valores válidos:\n- true: Ativado.\n- false: Desativado.	false
Ipv6Enabled	boolean	Indica se a versão do protocolo IP usada pelo load balancer para encaminhar tráfego para o grupo de servidores de back-end suporta IPv6. Valores válidos:\n- false (padrão): Não há suporte para IPv6. Para o tipo IPv4, apenas servidores de back-end IPv4 podem ser adicionados.\n- true: Tipo de pilha dupla. Servidores de back-end IPv4 e IPv6 podem ser adicionados.	false
ServerCount	integer	O número de servidores no grupo de servidores.	1
ServiceName	string	O nome do serviço.	test
UchConfig	object	As configurações de parâmetro de hash consistente de URL.
Type	string	O tipo de parâmetro. Somente QueryString é suportado.	QueryString
Value	string	O valor do parâmetro de hash consistente.	abc
CreateTime	string	A hora em que o recurso foi criado. A hora é exibida em UTC e segue o padrão ISO 8601 no formato AAAA-MM-DDTHH:mm:ssZ.	2022-07-02T02:49:05Z
ConnectionDrainConfig	object	A configuração de interrupção graceful de conexão. Quando a interrupção graceful de conexão está ativada, o balanceamento de carga permite que as conexões existentes sejam transmitidas normalmente dentro de um período especificado após a remoção de um servidor de back-end ou a falha de uma verificação de integridade. Nota A interrupção graceful de conexão não é suportada por instâncias da Basic Edition. Somente instâncias da Standard Edition e da WAF Enhanced Edition suportam este recurso. A interrupção graceful de conexão é suportada por grupos de servidores do tipo servidor e tipo IP, mas não por grupos de servidores do tipo Function Compute.
ConnectionDrainEnabled	boolean	Especifica se a drenagem de conexão deve ser ativada. true: Ativado. false: Desativado.	false
ConnectionDrainTimeout	integer	O período de tempo limite para a drenagem de conexão.	300
SlowStartConfig	object	A configuração de início lento. Após a ativação do início lento, os servidores de back-end recém-adicionados no grupo de servidores de back-end são aquecidos dentro de um período especificado, e o número de solicitações encaminhadas para os servidores aumenta linearmente. Nota O início lento não é suportado por instâncias da Basic Edition. Somente instâncias da Standard Edition e da WAF Enhanced Edition suportam este recurso. O início lento pode ser configurado para grupos de servidores do tipo servidor e tipo IP, mas não para grupos de servidores do tipo Function Compute. O início lento pode ser ativado somente quando o algoritmo de agendamento de back-end está definido como o algoritmo de sondagem ponderada.
SlowStartEnabled	boolean	Especifica se o início lento deve ser ativado. true: Ativado. false: Desativado.	false
SlowStartDuration	integer	A duração do início lento.	30
CrossZoneEnabled	boolean	Especifica se o balanceamento de carga entre zonas deve ser ativado para o grupo de servidores. Valores válidos: true: Ativado. Este é o valor padrão. false: Desativado.	true
IpVersionAffinityMode	string	O modo de afinidade de versão de IP. Valores válidos: NonAffinity: Sem modo de afinidade. Este é o valor padrão. Affinity: Modo de afinidade. Este parâmetro entra em vigor somente quando Ipv6Enabled está definido como true.	Affinity
TotalCount	integer	O número total de entradas.	1000

Exemplos

Resposta de sucesso

JSON formato

{
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f8****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876******",
  "ServerGroups": [
    {
      "HealthCheckConfig": {
        "HealthCheckConnectPort": 80,
        "HealthCheckEnabled": true,
        "HealthCheckHost": "www.example.com",
        "HealthCheckCodes": [
          "http_2xx"
        ],
        "HealthCheckHttpVersion": "HTTP1.1",
        "HealthCheckInterval": 5,
        "HealthCheckMethod": "HEAD",
        "HealthCheckPath": "/test/index.html",
        "HealthCheckProtocol": "HTTP",
        "HealthCheckTimeout": 3,
        "HealthyThreshold": 4,
        "UnhealthyThreshold": 4
      },
      "Protocol": "HTTP",
      "RelatedLoadBalancerIds": [
        "alb-n5qw04uq8savfe****"
      ],
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Scheduler": "Wrr",
      "ServerGroupId": "sgp-cige6j****",
      "ServerGroupName": "Group3",
      "ServerGroupStatus": "Available",
      "ServerGroupType": "Instance",
      "StickySessionConfig": {
        "Cookie": "B490B5EBF6F3CD402E515D22BCDA****",
        "CookieTimeout": 1000,
        "StickySessionEnabled": false,
        "StickySessionType": "Insert"
      },
      "VpcId": "vpc-bp15zckdt37pq72zv****",
      "Tags": [
        {
          "Key": "Test",
          "Value": "Test"
        }
      ],
      "ConfigManagedEnabled": false,
      "UpstreamKeepaliveEnabled": false,
      "Ipv6Enabled": false,
      "ServerCount": 1,
      "ServiceName": "test",
      "UchConfig": {
        "Type": "QueryString",
        "Value": "abc"
      },
      "CreateTime": "2022-07-02T02:49:05Z",
      "ConnectionDrainConfig": {
        "ConnectionDrainEnabled": false,
        "ConnectionDrainTimeout": 300
      },
      "SlowStartConfig": {
        "SlowStartEnabled": false,
        "SlowStartDuration": 30
      },
      "CrossZoneEnabled": true,
      "IpVersionAffinityMode": "Affinity"
    }
  ],
  "TotalCount": 1000
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.