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

Consulta uma lista de 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	Os IDs dos 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	Os nomes dos grupos de servidores. Você pode especificar até 10 nomes.
	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 de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Não é necessário especificar este parâmetro na primeira solicitação ou se não existir uma próxima consulta. Se existir uma próxima consulta, defina o valor como o valor NextToken retornado na chamada de API anterior.	FFmyTO70tTpLG6I3FmYAXG****
MaxResults	integer	Não	O número máximo de entradas a serem retornadas por página. 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 do grupo de servidores. Valores válidos: Instance: tipo servidor, que inclui instâncias ECS, ENI e ECI. Ip: tipo endereço IP. Fc: tipo Function Compute. Se você deixar este parâmetro vazio, todos os tipos de grupos de servidores serão consultados.	Instance
Tag	array<object>	Não	As tags vinculadas ao grupo de servidores. Você pode especificar até 10 tags em uma única solicitação.	Instance
	object	Não	A tag vinculada 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 da tag pode ter até 64 caracteres e não pode começar com `aliyun` ou `acs:`. Ela 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 da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Ele não pode conter `http://` ou `https://`.	Test

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
MaxResults	integer	O número de entradas por página em uma consulta paginada.	50
NextToken	string	Indica se existe uma próxima consulta. Valores válidos: Se NextToken estiver vazio, não existe uma próxima consulta. Se NextToken for retornado, o valor indica o token usado para iniciar 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. Um valor de 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: true: Ativado. false: Desativado.	true
HealthCheckHost	string	O nome de domínio usado para verificações de integridade. 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 de verificação de integridade. Especificar um nome de domínio: Insira um nome de domínio. O nome de domínio deve ter de 1 a 80 caracteres. O nome de domínio pode conter letras minúsculas, dígitos, hifens (-) e pontos (.). O nome de domínio deve conter pelo menos um ponto (.). Os pontos (.) não podem aparecer no início ou no final. O rótulo de domínio mais à direita pode conter apenas letras, não dígitos ou hifens (-). Hifens (-) não podem aparecer no início ou no final. Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	www.example.com
HealthCheckCodes	array	A lista de códigos de status que indicam verificações de integridade bem-sucedidas.
	string	O código de status que indica uma verificação de integridade bem-sucedida. Se HealthCheckProtocol estiver definido como HTTP ou HTTPS, HealthCheckCodes pode ser definido como http_2xx, http_3xx, http_4xx ou http_5xx. Separe vários códigos de status com vírgulas (,). Se HealthCheckProtocol estiver definido como gRPC, os valores válidos de HealthCheckCodes variam de 0 a 99. A entrada de intervalo é suportada, com um máximo de 20 valores de intervalo. Separe vários valores de intervalo com vírgulas (,). Nota Este parâmetro entra em vigor apenas 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 ou HTTP1.1. Nota Este parâmetro entra em vigor apenas 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 de verificação de integridade. Valores válidos: GET: Se o corpo da resposta exceder 8 KB, ele será truncado, mas isso não afeta o resultado da verificação de integridade. POST: As verificações de integridade de listener gRPC usam o método POST por padrão. HEAD: As verificações de integridade de listener HTTP e HTTPS usam o método HEAD por padrão. Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	HEAD
HealthCheckPath	string	O caminho da regra de encaminhamento para verificações de integridade. Nota Este parâmetro entra em vigor apenas quando HealthCheckProtocol está definido como HTTP ou HTTPS.	/test/index.html
HealthCheckProtocol	string	O protocolo de verificação de integridade. Valores válidos: HTTP: Envia solicitações HEAD ou GET para simular o comportamento de acesso do navegador e verificar se o aplicativo do servidor está íntegro. HTTPS: Envia solicitações HEAD ou GET para simular o comportamento de acesso do navegador e verificar se o aplicativo do servidor está íntegro. (A criptografia de dados é usada, o que é mais seguro que HTTP.) TCP: Envia pacotes de handshake SYN para verificar se a porta do servidor está ativa. gRPC: Envia solicitações POST ou GET para verificar se o aplicativo do servidor está íntegro.	HTTP
HealthCheckTimeout	integer	O tempo de espera por uma resposta de uma verificação de integridade. Se o servidor de back-end não responder corretamente dentro do tempo 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 antes que o status de verificação de integridade de um servidor de back-end mude de fail para success.	4
UnhealthyThreshold	integer	O número de verificações de integridade com falha consecutivas necessárias antes que o status de verificação de integridade de um servidor de back-end mude de success para fail.	4
Protocol	string	O tipo de protocolo de back-end. Valores válidos: HTTP: Pode ser associado a listeners HTTPS, HTTP e QUIC. HTTPS: Pode ser associado a listeners HTTPS. GRPC: Pode ser associado a 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: Wrr: Round-robin ponderado. Servidores de back-end com pesos maiores são consultados com mais frequência. Wlc: Menos conexões ponderadas. Além do polling baseado no peso de cada servidor de back-end, a carga real (número de conexões) do servidor de back-end também é considerada. Quando os pesos são iguais, os servidores de back-end com menos conexões atuais são consultados com mais frequência. Sch: Hashing consistente. Solicitações com o mesmo fator de hash são enviadas 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: Creating: O grupo de servidores está sendo criado. Available: O grupo de servidores está disponível. Configuring: O grupo de servidores está sendo configurado.	Available
ServerGroupType	string	O tipo de grupo de servidores. Valores válidos: Instance: Tipo de servidor, incluindo instâncias ECS, ENI e ECI. Ip: Tipo de endereço IP. Fc: Tipo Function Compute.	Instance
StickySessionConfig	object	A estrutura de 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. Nota Este parâmetro entra em vigor apenas 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: true: Ativado. false: Desativado.	false
StickySessionType	string	O método usado para lidar com cookies. Valores válidos: Insert: Insere um cookie. Quando um cliente acessa o servidor pela primeira vez, o load balancer insere um cookie (SERVERID) na resposta HTTP ou HTTPS. Na próxima vez que o cliente acessar o servidor com esse cookie, o load balancer encaminhará a solicitação para o servidor de back-end registrado anteriormente. Server: Reescreve 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 servidor com o novo cookie, o load balancer encaminhará a solicitação para o servidor de back-end registrado anteriormente.	Insert
VpcId	string	O ID da instância 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: true: Ativado. false: Desativado.	false
UpstreamKeepaliveEnabled	boolean	Indica se o keepalive de back-end está ativado. Valores válidos: true: Ativado. false: Desativado.	false
Ipv6Enabled	boolean	Indica se o IPv6 é suportado. Valores válidos: true: Suportado. false: Não suportado.	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âmetros de hash consistente de URL.
Type	string	O tipo de parâmetro. Apenas QueryString é suportado.	QueryString
Value	string	O valor do parâmetro de hash consistente.	abc
CreateTime	string	A hora em que o recurso foi criado.	2022-07-02T02:49:05Z
ConnectionDrainConfig	object	A configuração de drenagem de conexões. Após a drenagem de conexões ser ativada, quando um servidor de back-end é removido ou uma verificação de integridade falha, o load balancer permite que as conexões existentes continuem a transmissão normal de dados por um período especificado antes que a conexão seja interrompida. Nota Instâncias da Edição Básica não suportam drenagem de conexões. Apenas instâncias da Edição Padrão e da Edição com WAF habilitado suportam esse recurso. Grupos de servidores do tipo Servidor e do tipo IP suportam drenagem de conexões. Grupos de servidores do tipo Function Compute não suportam.
ConnectionDrainEnabled	boolean	Indica se a drenagem de conexões está ativada. true: Ativado. false: Desativado.	false
ConnectionDrainTimeout	integer	O período de tempo limite para drenagem de conexões.	300
SlowStartConfig	object	A configuração de início lento. Após o início lento ser ativado, os servidores de back-end recém-adicionados ao grupo de servidores são aquecidos dentro do período de tempo especificado. O número de solicitações encaminhadas para o servidor aumenta linearmente. Nota Instâncias da Edição Básica não suportam início lento. Apenas instâncias da Edição Padrão e da Edição com WAF habilitado suportam esse recurso. Grupos de servidores de back-end do tipo Servidor e do tipo IP suportam a configuração de início lento. Grupos de servidores de back-end do tipo Function Compute não suportam. O início lento só pode ser ativado quando o algoritmo de agendamento de back-end for round-robin ponderado.
SlowStartEnabled	boolean	Indica se o início lento está ativado. true: Ativado. false: Desativado.	false
SlowStartDuration	integer	A duração do início lento.	30
CrossZoneEnabled	boolean	Indica se o balanceamento de carga entre zonas está ativado para o grupo de servidores. Valores válidos: true: Ativado (padrão). false: Desativado.	true
IpVersionAffinityMode	string	O modo de afinidade de versão de IP do grupo de servidores.	Affinity
TotalCount	integer	O número de entradas retornadas.	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.