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

Consulta os grupos de servidores de uma instância de Gateway Load Balancer (GWLB).

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

gwlb:ListServerGroups

get

ServerGroup

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

ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

VPC

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

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 no máximo 20 IDs de grupos de servidores em cada chamada.
	string	Não	O ID do grupo de servidores.	sgp-atstuj3rtoptyui****
ServerGroupNames	array	Não	Os nomes dos grupos de servidores. Você pode especificar no máximo 20 nomes de grupos de servidores em cada chamada.
	string	Não	O nome do grupo de servidores.	testServerGroupName
ServerGroupType	string	Não	O tipo de grupo de servidores. Valores válidos: Instance: permite especificar recursos do tipo Ecs, Eni ou Eci. Ip: permite adicionar servidores especificando endereços IP.	Instance
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a instância pertence.	rg-atstuj3rtop****
Tag	array<object>	Não	As chaves de tag. Você pode especificar no máximo 20 tags em cada chamada.
	object	Não	A tag.
Key	string	Não	A chave da tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres e não pode começar com `acs:` ou `aliyun`. A chave da tag não pode conter `http://` ou `https://`.	testTagKey
Value	string	Não	O valor da tag. O valor da tag pode ter até 256 caracteres e não pode conter `http://` ou `https://`.	testTagValue
VpcId	string	Não	O ID da VPC.	vpc-bp15zckdt37pq72zv****
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: Se NextToken estiver vazio, não existe próxima página. Se um valor de NextToken for retornado, o valor indica o token usado para a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	Não	O número de entradas por página. Valores válidos: 1 a 1000. Valor padrão: 20.	20
Skip	integer	Não	O número de entradas a serem ignoradas na chamada.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
MaxResults	integer	O número de entradas por página. Valores válidos: 1 a 1000.	20
NextToken	string	Um token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Se NextToken estiver vazio, não existe próxima página. Se um valor de NextToken for retornado, o valor indica o token usado para a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	O ID da solicitação.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroups	array<object>	As configurações do grupo de servidores.
	array<object>	O grupo de servidores.
ConnectionDrainConfig	object	As configurações de connection draining.
ConnectionDrainEnabled	boolean	Indicates whether connection draining is enabled. Valid values: true false	false
ConnectionDrainTimeout	integer	The timeout period of connection draining. Unit: seconds Valid values: 1 to 3600.	300
CreateTime	string	A hora em que o recurso foi criado. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2024-08-05T18:24:07Z
HealthCheckConfig	object	A configuração de health checks.
HealthCheckConnectPort	integer	The backend server port that is used for health checks. Valid values: 1 to 65535.	80
HealthCheckConnectTimeout	integer	The maximum timeout period of a health check. Unit: seconds Valid values: 1 to 300.	5
HealthCheckDomain	string	The domain name that is used for health checks. Valid values: $SERVER_IP: the internal IP address of a backend server. domain: a domain name. The domain name must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), and periods (.). Nota This parameter takes effect only if you set HealthCheckProtocol to HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	Indicates whether the health check feature is enabled. Valid values: true false	true
HealthCheckHttpCode	array	The HTTP status codes that the system returns for health checks.
	string	The HTTP status code to return for health checks. Separate multiple HTTP status codes with commas (,). Valid values: http_2xx http_3xx http_4xx http_5xx Default value: http_2xx. Nota This parameter takes effect only if you set HealthCheckProtocol to HTTP.	http_2xx
HealthCheckInterval	integer	The interval at which health checks are performed. Unit: seconds Valid values: 1 to 50.	10
HealthCheckPath	string	The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, and the following special characters: `- / . % ? # &` The URL must start with a forward slash (/). Nota This parameter takes effect only if you set HealthCheckProtocol to HTTP.	/test/index.html
HealthCheckProtocol	string	The protocol that is used for health checks. Valid values: TCP: TCP health checks send TCP SYN packets to a backend server to check whether the port of the backend server is reachable. HTTP: HTTP health checks simulate a process that uses a web browser to access resources by sending HEAD or GET requests to an instance. These requests are used to check whether the instance is healthy.	TCP
HealthyThreshold	integer	The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status changes from fail to success. Valid values: 2 to 10.	2
UnhealthyThreshold	integer	The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status changes from success to fail. Valid values: 2 to 10.	2
HealthCheckReq	string
HealthCheckExp	string
Protocol	string	O protocolo de back-end. Valores válidos: GENEVE.	GENEVE
RelatedLoadBalancerIds	array	Os IDs das instâncias GWLB associadas ao grupo de servidores.
	string	O ID da instância GWLB associada ao grupo de servidores.	gwlb-cp6prgqy40hols****
ResourceGroupId	string	O ID do grupo de recursos.	rg-atstuj3rtop****
Scheduler	string	O algoritmo de agendamento. Valores válidos: 5TCH: indica hash consistente baseado nos seguintes fatores: endereço IP de origem, endereço IP de destino, porta de origem, protocolo e porta de destino. As solicitações que contêm as mesmas informações com base nos fatores anteriores são encaminhadas para o mesmo servidor de back-end. 3TCH: indica hash consistente baseado nos seguintes fatores: endereço IP de origem, endereço IP de destino e protocolo. As solicitações que contêm as mesmas informações com base nos fatores anteriores são encaminhadas para o mesmo servidor de back-end. 2TCH: indica hash consistente baseado nos seguintes fatores: endereço IP de origem e endereço IP de destino. As solicitações que contêm as mesmas informações com base nos fatores anteriores são encaminhadas para o mesmo servidor de back-end.	5TCH
ServerCount	integer	O número de servidores.	2
ServerGroupId	string	O ID do grupo de servidores.	sgp-atstuj3rtoptyui****
ServerGroupName	string	O nome do grupo de servidores.	testServerGroupName
ServerGroupStatus	string	O status do grupo de servidores. Valores válidos: Creating Available Configuring	Available
ServerGroupType	string	O tipo de grupo de servidores. Valores válidos: Instance: permite especificar servidores do tipo Ecs, Eni ou Eci. Ip: permite adicionar servidores especificando endereços IP.	Instance
ServerFailoverMode	string	Especifica como o GWLB processa solicitações em conexões existentes quando um servidor de back-end não está funcionando conforme o esperado. Valores válidos: NoRebalance: o GWLB continua a encaminhar solicitações pelas conexões existentes para o servidor de back-end não íntegro. Rebalance: o GWLB encaminha solicitações pelas conexões existentes para os servidores de back-end íntegros restantes.	NoRebalance
Tags	array<object>	As tags.
	object	A tag.
Key	string	The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length, and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.	testTagKey
Value	string	The tag value. The tag value can be up to 256 characters in length and cannot contain `http://` or `https://`.	testTagValue
VpcId	string	O ID da VPC.	vpc-bp15zckdt37pq72zv****
TotalCount	integer	O número total de entradas retornadas.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroups": [
    {
      "ConnectionDrainConfig": {
        "ConnectionDrainEnabled": false,
        "ConnectionDrainTimeout": 300
      },
      "CreateTime": "2024-08-05T18:24:07Z",
      "HealthCheckConfig": {
        "HealthCheckConnectPort": 80,
        "HealthCheckConnectTimeout": 5,
        "HealthCheckDomain": "$SERVER_IP",
        "HealthCheckEnabled": true,
        "HealthCheckHttpCode": [
          "http_2xx"
        ],
        "HealthCheckInterval": 10,
        "HealthCheckPath": "/test/index.html",
        "HealthCheckProtocol": "TCP",
        "HealthyThreshold": 2,
        "UnhealthyThreshold": 2,
        "HealthCheckReq": "",
        "HealthCheckExp": ""
      },
      "Protocol": "GENEVE",
      "RelatedLoadBalancerIds": [
        "gwlb-cp6prgqy40hols****"
      ],
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Scheduler": "5TCH",
      "ServerCount": 2,
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerGroupName": "testServerGroupName",
      "ServerGroupStatus": "Available",
      "ServerGroupType": "Instance",
      "ServerFailoverMode": "NoRebalance",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-bp15zckdt37pq72zv****"
    }
  ],
  "TotalCount": 1
}

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.