ListEndpointGroups - Global Accelerator: Central de Documentação do Alibaba Cloud

Consulta os grupos de endpoints.

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

ga:ListEndpointGroups

list

*EndpointGroup.

acs:ga:{#regionId}:{#accountId}:endpointgroup/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância do Alibaba Cloud Global Accelerator (GA). Somente cn-hangzhou é suportado.	cn-hangzhou
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas por página em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
AcceleratorId	string	Sim	O ID da instância do Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	Não	O ID da instância do listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	Não	O tipo do grupo de endpoints. Valores válidos: default: grupo de endpoints padrão. virtual: grupo de endpoints virtual. Valor vazio: todos os grupos de endpoints padrão e virtuais. Valores válidos: default : Grupo de endpoints padrão. virtual : Grupo de endpoints virtual.	virtual
AccessLogSwitch	string	Não	Especifica se o log de acesso deve ser ativado. Valores válidos: on: ativa o log de acesso. off (padrão): desativa o log de acesso.	on
EndpointGroupId	string	Não	O ID do grupo de endpoints.	epg-bp16jdc00bhe97sr5****
Tag	array<object>	Não	As tags do grupo de endpoints.
	object	Não	As tags do grupo de endpoints.
Key	string	Não	A chave da tag do grupo de endpoints. A chave da tag não pode ser uma string vazia. 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://`. Você pode especificar até 20 chaves de tag.	test-key
Value	string	Não	O valor da tag do grupo de endpoints. O valor da tag pode ser uma string vazia. 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://`. Você pode especificar até 20 valores de tag.	test-value
EndpointGroupRegion	string	Não	O ID da região do grupo de endpoints usado para filtragem.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A lista de informações de resposta.
TotalCount	integer	O número total de entradas.	1
PageSize	integer	O número de entradas retornadas por página.	10
RequestId	string	O ID da solicitação.	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	O número da página.	1
EndpointGroups	array<object>	As informações de configuração do grupo de endpoints.
	array<object>	As informações de configuração do grupo de endpoints.
EndpointGroupId	string	O ID do grupo de endpoints.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	A lista de endereços IP públicos de saída para o grupo de endpoints. Importante Para grupos de endpoints que usam roteamento de retorno à origem por rede privada, o console exibe apenas os endereços privados de retorno à origem e não exibe mais os endereços públicos. Se o tipo de conectividade de rede do serviço de backend no grupo de endpoints mudar (por exemplo, de uma rede privada para uma rede pública, ou para um roteamento de retorno à origem híbrido de rede pública e privada), preste muita atenção às mudanças nos endereços de retorno à origem e atualize a lista de ACL do serviço de backend de forma sincronizada.
	string	O endereço IP público de saída do grupo de endpoints.	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	A lista de novos endereços IP do grupo de endpoints que estão pendentes de confirmação após a atualização da instância do Alibaba Cloud Global Accelerator (GA).
	string	A lista de novos endereços IP do grupo de endpoints que estão pendentes de confirmação após a atualização da instância do Alibaba Cloud Global Accelerator (GA).	47.1.XX.XX
State	string	O status do grupo de endpoints. init: Inicializando. active: Normal. updating: Atualizando. deleteing: Excluindo.	active
HealthCheckPath	string	O caminho de verificação de integridade.	/healthcheck
EndpointGroupRegion	string	O ID da região à qual o grupo de endpoints pertence.	cn-hangzhou
HealthCheckIntervalSeconds	integer	O intervalo entre as verificações de integridade. Unidade: segundos.	3
TrafficPercentage	integer	A porcentagem de tráfego roteada para o grupo de endpoints quando um listener está associado a vários grupos de endpoints.	100
HealthCheckProtocol	string	O protocolo de verificação de integridade. tcp ou TCP: TCP. http ou HTTP: HTTP. https ou HTTPS: HTTPS.	tcp
ThresholdCount	integer	O número de verificações de integridade com falha consecutivas antes que um endpoint seja declarado como não íntegro.	3
ListenerId	string	O ID da instância do listener.	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	O ID da instância do Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	As informações de configuração do endpoint.
	object	As informações de configuração do endpoint.
Type	string	O tipo de endpoint. Domain: Nome de domínio personalizado. Ip: Endereço IP personalizado. IpTarget: Endereço IP privado personalizado. PublicIp: Endereço IP público da Alibaba Cloud. ECS: Instância ECS. SLB: Instância SLB. ALB: Instância ALB. OSS: Instância OSS. ENI: Interface de rede elástica (ENI) da Alibaba Cloud. NLB: Instância NLB.	Ip
EnableClientIPPreservation	boolean	Especifica se o recurso de preservação do endereço IP do cliente está ativado usando o método de recuperação automática. true: O recurso de preservação do endereço IP do cliente está ativado. false: O recurso de preservação do endereço IP do cliente está desativado.	false
Weight	integer	O peso do endpoint.	20
ProbeProtocol	string	O protocolo de sondagem para monitoramento de latência. icmp: ICMP. tcp: TCP.	tcp
Endpoint	string	O endereço IP, nome de domínio ou ID da instância do endpoint.	47.1.XX.XX
EnableProxyProtocol	boolean	Especifica se o recurso de preservação do endereço IP do cliente está ativado usando o Proxy Protocol. true: O recurso de preservação do endereço IP do cliente está ativado usando o Proxy Protocol. false: O recurso de preservação do endereço IP do cliente não está ativado usando o Proxy Protocol.
ProbePort	integer	A porta de sondagem para monitoramento de latência.	80
EndpointId	string	O ID do endpoint.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	O endereço IP privado da interface de rede elástica (ENI).	172.168.XX.XX
VpcId	string	O ID da VPC.	vpc-8vbhucmd5b2q2fpqqu****
VSwitchIds	array	A lista de vSwitches na VPC.
	string	O ID do vSwitch.	vsw-hp3xwc2aebg2u30ln****
Provider	string	As informações do provedor.	BAILIAN
ApiKeys	array	As chaves de API na configuração do endpoint.
	string	A primeira chave de API no grupo de endpoints.	sk-*******
PortOverrides	array<object>	Os mapeamentos de porta.
	object	Os mapeamentos de porta.
ListenerPort	integer	A porta do listener.	443
EndpointPort	integer	A porta do endpoint.	80
ForwardingRuleIds	array	Os IDs das regras de encaminhamento associadas ao grupo de endpoints.
	string	Os IDs das regras de encaminhamento associadas ao grupo de endpoints.	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	O tipo de grupo de endpoints. default: Grupo de endpoints padrão. virtual: Grupo de endpoints virtual.	default
EndpointRequestProtocol	string	O protocolo do serviço de backend. HTTP: HTTP. HTTPS: HTTPS.	HTTP
EndpointProtocolVersion	string	A versão do protocolo do serviço de backend. HTTP1.1: HTTP1.1. HTTP2: HTTP2.	HTTP1.1
Description	string	A descrição do grupo de endpoints.	group1
Name	string	O nome do grupo de endpoints.	group1
HealthCheckPort	integer	A porta de verificação de integridade.	10
HealthCheckEnabled	boolean	Especifica se as verificações de integridade estão ativadas. true: As verificações de integridade estão ativadas. false: As verificações de integridade estão desativadas.	true
ServiceId	string	O ID do provedor de serviços ao qual a instância gerenciada pertence. Nota Este parâmetro é válido apenas quando o parâmetro ServiceManaged está definido como true.	ALB
ServiceManaged	boolean	Especifica se a instância é uma instância gerenciada. Valores válidos: true: A instância é uma instância gerenciada. false: A instância não é uma instância gerenciada.	true
ServiceManagedInfos	array<object>	A lista de políticas de ação que os usuários podem executar nesta instância gerenciada. Nota Este parâmetro é válido apenas quando o parâmetro ServiceManaged está definido como true. Quando uma instância está no estado gerenciado, as operações do usuário na instância são restritas e certas operações são proibidas.
	object	A política de ação que um usuário pode executar na instância gerenciada.
Action	string	O nome da ação da política gerenciada. Create: Criar uma instância. Update: Atualizar a instância atual. Delete: Excluir a instância atual. Associate: Referenciar ou ser referenciado pela instância atual. UserUnmanaged: Remover o gerenciamento da instância. CreateChild: Criar um recurso filho sob a instância atual.	Update
ChildType	string	O tipo de recurso filho. Listener: Recurso de listener. IpSet: Recurso de região de aceleração. EndpointGroup: Recurso de grupo de endpoints. ForwardingRule: Recurso de regra de encaminhamento. Endpoint: Recurso de endpoint. EndpointGroupDestination: O recurso de mapeamento de protocolo do grupo de endpoints sob um listener de roteamento personalizado. EndpointPolicy: O recurso de política de acesso do endpoint sob um listener de roteamento personalizado. Nota Este parâmetro é válido apenas quando o parâmetro Action está definido como CreateChild.	Listener
IsManaged	boolean	Especifica se a ação da política gerenciada é gerenciada. Valores válidos: true: A ação da política gerenciada é gerenciada. Os usuários não têm permissões para executar a operação especificada por Action na instância gerenciada. false: A ação da política gerenciada não é gerenciada. Os usuários podem executar a operação especificada por Action na instância gerenciada.	false
Tags	array<object>	As tags do grupo de endpoints.
	object	As tags do grupo de endpoints.
Key	string	A chave da tag do grupo de endpoints.	test-key
Value	string	O valor da tag do grupo de endpoints.	test-value
HealthCheckHost	string	O nome de domínio de verificação de integridade.	www.taobao.com
EndpointIpVersion	string	O protocolo de endereço IP de backend. Valores válidos: IPv4: (padrão) O GA usa apenas endereços IPv4 para se comunicar com o serviço de endpoint. IPv6: O GA usa apenas endereços IPv6 para se comunicar com o serviço de endpoint. ProtocolAffinity: O protocolo IP usado pelo GA para se comunicar com o serviço de endpoint é o mesmo protocolo IP usado pela solicitação do cliente.	IPv4
EndpointPrivateIpList	array<object>	A lista de endereços IP privados dos nós de backend.
	object
PrivateIp	string	O endereço IP privado.	172.19.115.37
VSwitchId	string	O ID do vSwitch na VPC.	gsw-0jl6tmriqep1ga***
CIDR	string	O bloco CIDR associado ao endereço IP privado.	10.0.0.0/24
HealthCheckSuccessCodes	string	O conjunto de códigos de status que indicam uma verificação de integridade bem-sucedida.	http_2xx,http_3xx
HealthCheckMethod	string	O método de solicitação HTTP usado para verificações de integridade.	GET
ProxyTunnel	object	A configuração do túnel de proxy.
ConnectAuthPrefix	string	O prefixo de autenticação de conexão do túnel de proxy.	prefix-auth
ConnectAuthSuffix	string	O sufixo de autenticação de conexão do túnel de proxy.	suffix-auth
ConnectSessionHashHdr	string	O nome do cabeçalho de solicitação usado para hash de sessão.	X-Session-Hash
ConnectTunnelTimeout	integer	O período de tempo limite de conexão do túnel de proxy. Unidade: milissegundos.	5000
TunnelServerPort	integer	A porta do servidor de túnel.	8443
TunnelServerType	string	O tipo de endereço do servidor de túnel. Valores válidos: ip (endereço IPv4) e domain (nome de domínio).	domain
TunnelServer	string	O endereço IPv4 ou o nome de domínio do servidor de túnel.	tunnel.example.com

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "A052D49E-CCC2-41DB-816C-DC3381503194\t",
  "PageNumber": 1,
  "EndpointGroups": [
    {
      "EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
      "EndpointGroupIpList": [
        "47.1.XX.XX"
      ],
      "EndpointGroupUnconfirmedIpList": [
        "47.1.XX.XX"
      ],
      "State": "active",
      "HealthCheckPath": "/healthcheck",
      "EndpointGroupRegion": "cn-hangzhou",
      "HealthCheckIntervalSeconds": 3,
      "TrafficPercentage": 100,
      "HealthCheckProtocol": "tcp",
      "ThresholdCount": 3,
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "EndpointConfigurations": [
        {
          "Type": "Ip",
          "EnableClientIPPreservation": false,
          "Weight": 20,
          "ProbeProtocol": "tcp",
          "Endpoint": "47.1.XX.XX",
          "EnableProxyProtocol": false,
          "ProbePort": 80,
          "EndpointId": "ep-bp1d2utp8qqe2a44t****",
          "SubAddress": "172.168.XX.XX",
          "VpcId": "vpc-8vbhucmd5b2q2fpqqu****",
          "VSwitchIds": [
            "vsw-hp3xwc2aebg2u30ln****"
          ],
          "Provider": "BAILIAN",
          "ApiKeys": [
            "sk-*******"
          ]
        }
      ],
      "PortOverrides": [
        {
          "ListenerPort": 443,
          "EndpointPort": 80
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp19a3t3yzr21q3****"
      ],
      "EndpointGroupType": "default",
      "EndpointRequestProtocol": "HTTP",
      "EndpointProtocolVersion": "HTTP1.1",
      "Description": "group1",
      "Name": "group1",
      "HealthCheckPort": 10,
      "HealthCheckEnabled": true,
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "Tags": [
        {
          "Key": "test-key",
          "Value": "test-value"
        }
      ],
      "HealthCheckHost": "www.taobao.com",
      "EndpointIpVersion": "IPv4",
      "EndpointPrivateIpList": [
        {
          "PrivateIp": "172.19.115.37",
          "VSwitchId": "gsw-0jl6tmriqep1ga***",
          "CIDR": "10.0.0.0/24"
        }
      ],
      "HealthCheckSuccessCodes": "http_2xx,http_3xx",
      "HealthCheckMethod": "GET",
      "ProxyTunnel": {
        "ConnectAuthPrefix": "prefix-auth",
        "ConnectAuthSuffix": "suffix-auth",
        "ConnectSessionHashHdr": "X-Session-Hash",
        "ConnectTunnelTimeout": 5000,
        "TunnelServerPort": 8443,
        "TunnelServerType": "domain",
        "TunnelServer": "tunnel.example.com"
      }
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NoPermission	No permissions.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.