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

Obtém 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. Você pode especificar até 20 IDs em uma única solicitação.
	string	Não	O ID do grupo de servidores.	sgp-atstuj3rtop****
ServerGroupNames	array	Não	Os nomes dos grupos de servidores. Você pode especificar até 10 nomes em uma única solicitação.
	string	Não	O nome do grupo de servidores.	Group3
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-atstuj3rtop****
NextToken	string	Não	O token usado para a próxima consulta. Se esta for sua primeira consulta ou se nenhuma próxima consulta será enviada, você pode deixar este parâmetro vazio. Se uma consulta subsequente será enviada, defina este parâmetro com o valor de NextToken da resposta anterior da API.	FFmyTO70tTpLG6I3FmYAXG****
MaxResults	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Valor padrão: 20.	20
VpcId	string	Não	O ID da virtual private cloud (VPC).	vpc-bp15zckdt37pq72zv****
ServerGroupType	string	Não	O tipo do grupo de servidores. Valores válidos: Instance: permite adicionar servidores dos tipos ECS, ENI e ECI. Ip: permite adicionar servidores com endereços IP especificados. Fc: permite adicionar funções do Function Compute como servidores backend. Se você não especificar este parâmetro, o sistema consultará grupos de servidores de todos os tipos.	Instance
Tag	array<object>	Não	As tags. Você pode especificar até 10 tags em uma única solicitação.	Instance
	object	Não	Uma tag que consiste em um par chave-valor.
Key	string	Não	A chave da tag. A chave da tag pode ter até 128 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. O valor da tag 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 retornada.
MaxResults	integer	O número de entradas retornadas por página.	50
NextToken	string	O token usado para recuperar a próxima página de resultados. Valores válidos: Se NextToken estiver vazio, não há mais resultados disponíveis. Se um valor for retornado, use-o para recuperar a próxima página de resultados.	caeba0bbb2be03f8****
RequestId	string	O ID da solicitação.	CEF72CEB-54B6-4AE8-B225-F876******
ServerGroups	array<object>	A lista de grupos de servidores.
	array<object>	A lista de grupos de servidores.
HealthCheckConfig	object	A configuração de verificação de integridade.
HealthCheckConnectPort	integer	The port on the backend server used for health checks. Valid values: 0 to 65535. If the value is 0, the backend server port is used for health checks.	80
HealthCheckEnabled	boolean	Indicates whether health checks are enabled. Valid values: true: Enabled. false: Disabled.	true
HealthCheckHost	string	The domain name that is used for health checks. The private IP address of the backend server (Default): The private IP address of the backend server is used for health checks. A custom domain name: Specify a domain name that meets the following requirements: The domain name must be 1 to 80 characters in length. It can contain lowercase letters, digits, hyphens (-), and periods (.). It must contain at least one period (.). The period (.) cannot be the first or last character. The rightmost domain label can contain only letters and cannot contain digits or hyphens (-). The hyphen (-) cannot be the first or last character. Nota This parameter is valid only when `HealthCheckProtocol` is set to `HTTP`, `HTTPS`, or `gRPC`.	www.example.com
HealthCheckCodes	array	The list of status codes that indicate a successful health check.
	string	The status code that indicates a successful health check. If HealthCheckProtocol is set to HTTP or HTTPS, valid values for HealthCheckCodes are http_2xx, http_3xx, http_4xx, and http_5xx. Separate multiple values with commas (,). If HealthCheckProtocol is set to gRPC, the valid status code range for HealthCheckCodes is 0 to 99. You can specify up to 20 value ranges. Separate multiple ranges with commas (,). Nota This parameter is valid only when HealthCheckProtocol is set to HTTP, HTTPS, or gRPC.	http_2xx
HealthCheckHttpVersion	string	The HTTP version that is used for health checks. Valid values: HTTP1.0 or HTTP1.1. Nota This parameter is valid only when HealthCheckProtocol is set to HTTP or HTTPS.	HTTP1.1
HealthCheckInterval	integer	The interval at which health checks are performed, in seconds. Valid values: 1 to 50.	5
HealthCheckMethod	string	The health check method. Valid values: GET: If the response body exceeds 8 KB, it is truncated. This does not affect the health check result. POST: gRPC health checks use the POST method by default. HEAD: HTTP and HTTPS health checks use the HEAD method by default. Nota This parameter is valid only when HealthCheckProtocol is set to HTTP, HTTPS, or gRPC.	HEAD
HealthCheckPath	string	The path that is used for health checks. Nota This parameter is valid only when HealthCheckProtocol is set to HTTP or HTTPS.	/test/index.html
HealthCheckProtocol	string	The protocol that is used for health checks. Valid values: HTTP: The load balancer sends HEAD or GET requests to check the health of the backend server. HTTPS: The load balancer sends HEAD or GET requests to check the health of the backend server. HTTPS provides higher security than HTTP because data is encrypted. TCP: The load balancer sends SYN packets to check whether the port of the backend server is reachable. gRPC: The load balancer sends POST or GET requests to check the health of the backend server.	HTTP
HealthCheckTimeout	integer	The timeout for a health check response, in seconds. If a backend server does not respond within this timeout, the health check fails.	3
HealthyThreshold	integer	The number of consecutive successful health checks required for a backend server to change its status from unhealthy to healthy.	4
UnhealthyThreshold	integer	The number of consecutive failed health checks required for a backend server to change its status from healthy to unhealthy.	4
Protocol	string	O protocolo do backend. 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 de load balancer 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 backend com pesos maiores recebem mais solicitações. Wlc: menor número de conexões ponderado. O load balancer considera tanto o peso quanto o número de conexões ativas de cada servidor backend. Se os pesos forem iguais, o servidor backend com menos conexões ativas será selecionado. Sch: hashing consistente. Solicitações com a mesma chave de hash são roteadas para o mesmo servidor backend. Por padrão, a chave de hash é o endereço IP de origem. Se `UchConfig` estiver configurado, a chave de hash será um parâmetro de URL.	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 atualizado.	Available
ServerGroupType	string	O tipo do grupo de servidores. Valores válidos: Instance: um grupo de servidores do tipo instância ao qual você pode adicionar instâncias ECS, interfaces de rede elásticas (ENIs) e instâncias ECI. IP: um grupo de servidores baseado em IP. Function Compute: um grupo de servidores baseado em Function Compute.	Instance
StickySessionConfig	object	A configuração de sessão persistente.
Cookie	string	The cookie that is configured on the backend server.	B490B5EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	The timeout period of the cookie, in seconds. Valid values: 1 to 86400. Nota This parameter takes effect when StickySessionEnabled is set to true and StickySessionType is set to Insert.	1000
StickySessionEnabled	boolean	Specifies whether to enable sticky sessions. Valid values: true: Enabled. false: Disabled.	false
StickySessionType	string	The method that is used to manage cookies. Valid values: Insert: Inserts a cookie. When a client makes its first request, the load balancer inserts a `SERVERID` cookie into the response. Subsequent requests from the client will include this cookie, and the load balancer will route these requests to the same backend server. Server: Rewrites a cookie. If the load balancer detects a user-defined cookie, it overwrites the original cookie in the response. Subsequent requests from the client will include the new cookie, and the load balancer will route these requests to the same backend server.	Insert
VpcId	string	O ID da VPC.	vpc-bp15zckdt37pq72zv****
Tags	array<object>	A lista de tags associadas ao grupo de servidores.
	object	A lista de tags associadas ao grupo de servidores.
Key	string	The tag key.	Test
Value	string	The tag value.	Test
ConfigManagedEnabled	boolean	Especifica se o gerenciamento de configuração está ativado. Valores válidos: true: Ativado. false: Desativado.	false
UpstreamKeepaliveEnabled	boolean	Especifica se as conexões keep-alive do backend estão ativadas. Valores válidos: true: Ativadas. false: Desativadas.	false
Ipv6Enabled	boolean	Especifica se o IPv6 está ativado. Valores válidos: true: Ativado. false: Desativado.	false
ServerCount	integer	O número de servidores backend no grupo de servidores.	1
ServiceName	string	O nome do serviço.	test
UchConfig	object	A configuração de hashing consistente baseado em URL.
Type	string	The type of the parameter. The value must be `QueryString`.	QueryString
Value	string	The value of the consistent hashing parameter.	abc
CreateTime	string	A hora em que o grupo de servidores foi criado.	2022-07-02T02:49:05Z
ConnectionDrainConfig	object	A configuração de drenagem de conexões. Se você ativar a drenagem de conexões, o load balancer permitirá que conexões existentes sejam processadas dentro de um período especificado após um servidor backend ser removido ou falhar em uma verificação de integridade. Nota Uma instância básica não suporta drenagem de conexões. Apenas instâncias padrão e instâncias habilitadas para WAF suportam esse recurso. A drenagem de conexões é suportada por grupos de servidores do tipo instância e baseados em IP, mas não por grupos de servidores baseados em Function Compute.
ConnectionDrainEnabled	boolean	Specifies whether to enable connection draining. Valid values: true: Enabled. false: Disabled.	false
ConnectionDrainTimeout	integer	The timeout period for connection draining.	300
SlowStartConfig	object	A configuração de início lento. Após ativar o início lento, o load balancer aquece os servidores backend recém-adicionados por um período especificado. O número de solicitações roteadas para esses servidores aumenta linearmente durante o período de aquecimento. Nota Uma instância básica não suporta início lento. Apenas instâncias padrão e instâncias habilitadas para WAF suportam esse recurso. Grupos de servidores do tipo instância e baseados em IP suportam início lento. Grupos de servidores baseados em Function Compute não suportam. Você pode ativar o início lento apenas quando o algoritmo de agendamento for round robin ponderado.
SlowStartEnabled	boolean	Specifies whether to enable slow start. Valid values: true: Enabled. false: Disabled.	false
SlowStartDuration	integer	The slow start duration, in seconds.	30
CrossZoneEnabled	boolean	Especifica 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		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.