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

Lista 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 onde a instância do Global Accelerator está implantada. Defina o valor como cn-hangzhou.	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 em cada página. Valor máximo: 50. Valor padrão: 10.	10
AcceleratorId	string	Sim	O ID da instância do Global Accelerator.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Não	O ID do listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	Não	O tipo do grupo de endpoints. Valores válidos: default: um grupo de endpoints padrão. virtual: um grupo de endpoints virtual. Se você omitir este parâmetro, a operação retornará todos os grupos de endpoints padrão e virtuais.	virtual
AccessLogSwitch	string	Não	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 usadas para filtrar grupos de endpoints. Você pode especificar até 20 tags.
	object	Não	Uma 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é 64 caracteres e não pode começar com `aliyun` ou `acs:`, nem conter `http://` ou `https://`.	test-key
Value	string	Não	O valor da tag. 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:`, nem conter `http://` ou `https://`.	test-value

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados de resposta.
TotalCount	integer	O número total de entradas retornadas.	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>	A lista de grupos de endpoints.
	array<object>	A lista de grupos de endpoints.
EndpointGroupId	string	O ID do grupo de endpoints.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	Uma lista de endereços IP públicos de saída do grupo de endpoints. Importante Para grupos de endpoints conectados a serviços de backend privados, o console exibe apenas os endereços IP de origem privados, não os públicos. Se o tipo de conexão de rede de um serviço de backend mudar (por exemplo, de privado para público), monitore os endereços IP de origem e atualize a lista de controle de acesso (ACL) do serviço de backend.
	string	Um 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 no grupo de endpoints que requerem confirmação após a atualização de uma instância do Global Accelerator.
	string	Um novo endereço IP no grupo de endpoints que requer confirmação após a atualização de uma instância do Global Accelerator.	47.1.XX.XX
State	string	O estado do grupo de endpoints. init: O grupo de endpoints está inicializando. active: O grupo de endpoints está estável. updating: O grupo de endpoints está atualizando. deleting: O grupo de endpoints está sendo excluído.	active
HealthCheckPath	string	O caminho de verificação de integridade.	/healthcheck
EndpointGroupRegion	string	O ID da região onde o grupo de endpoints está implantado.	cn-hangzhou
HealthCheckIntervalSeconds	integer	O intervalo de verificação de integridade, em segundos.	3
TrafficPercentage	integer	A porcentagem de tráfego roteado para o grupo de endpoints. Este parâmetro se aplica apenas se um listener estiver associado a vários grupos de endpoints.	100
HealthCheckProtocol	string	O protocolo usado para verificações 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 consecutivas com falha necessárias para marcar um endpoint como não íntegro.	3
ListenerId	string	O ID do listener.	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	O ID da instância do Global Accelerator.	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	Uma lista de configurações de endpoints.
	object	Uma configuração de endpoint.
Type	string	The type of endpoint. Valid values: Domain: a custom domain name. Ip: a custom IP address. IpTarget: a custom private IP address. PublicIp: an Alibaba Cloud public IP address. ECS: an Alibaba Cloud ECS instance. SLB: an Alibaba Cloud SLB instance. ALB: an Alibaba Cloud ALB instance. OSS: an Alibaba Cloud OSS bucket. ENI: an Alibaba Cloud elastic network interface. NLB: an Alibaba Cloud NLB instance.	Ip
EnableClientIPPreservation	boolean	Specifies whether to preserve client IP addresses. true: Client IP preservation is enabled. false: Client IP preservation is disabled.	false
Weight	integer	The weight of the endpoint.	20
ProbeProtocol	string	The protocol that is used for latency monitoring probes. icmp: ICMP tcp: TCP	tcp
Endpoint	string	The endpoint's IP address, domain name, or instance ID.	47.1.XX.XX
EnableProxyProtocol	boolean	Specifies whether to use Proxy Protocol to preserve client IP addresses. true: Proxy Protocol is enabled. false: Proxy Protocol is disabled.
ProbePort	integer	The port used for latency monitoring probes.	80
EndpointId	string	The ID of the endpoint.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	The private IP address of the elastic network interface.	172.168.XX.XX
VpcId	string	The ID of the VPC.	vpc-8vbhucmd5b2q2fpqqu****
VSwitchIds	array	A list of vSwitches in the VPC.
	string	The ID of the vSwitch.	vsw-hp3xwc2aebg2u30ln****
Provider	string	The service provider.	BAILIAN
ApiKeys	array	The API keys in the endpoint configuration.
	string	An API key of the endpoint.	sk-*******
PortOverrides	array<object>	Os mapeamentos de porta.
	object	Os mapeamentos de porta.
ListenerPort	integer	The listener port.	443
EndpointPort	integer	The endpoint port.	80
ForwardingRuleIds	array	Os IDs das regras de encaminhamento associadas ao grupo de endpoints.
	string	O ID de uma regra de encaminhamento associada ao grupo de endpoints.	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	O tipo do grupo de endpoints. Valores válidos: default: um grupo de endpoints padrão. virtual: um grupo de endpoints virtual.	default
EndpointRequestProtocol	string	O protocolo do serviço de backend. Valores válidos: HTTP: HTTP HTTPS: HTTPS	HTTP
EndpointProtocolVersion	string	A versão do protocolo do serviço de backend. Valores válidos: HTTP1.1: HTTP/1.1 HTTP2: HTTP/2	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 usada para verificações de integridade.	10
HealthCheckEnabled	boolean	Especifica se as verificações de integridade devem ser 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 serviço que gerencia a instância. Nota Este parâmetro é retornado apenas se ServiceManaged for true.	ALB
ServiceManaged	boolean	Especifica se a 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>	As ações que você pode executar na instância gerenciada. Nota Este parâmetro é retornado apenas se ServiceManaged for true. Suas permissões para operar em uma instância gerenciada são restritas.
	object	As ações que você pode executar na instância gerenciada.
Action	string	The name of the action on the managed instance. Valid values: Create: creates an instance. Update: updates the instance. Delete: deletes the instance. Associate: associates the instance with other resources. UserUnmanaged: Reverts the instance to an unmanaged state. CreateChild: creates a child resource for the instance.	Update
ChildType	string	The type of the child resource. Valid values: Listener: a listener. IpSet: an acceleration region. EndpointGroup: an endpoint group. ForwardingRule: a forwarding rule. Endpoint: an endpoint. EndpointGroupDestination: a protocol mapping for an endpoint group of a custom routing listener. EndpointPolicy: a traffic policy for an endpoint of a custom routing listener. Nota This parameter is returned only if Action is set to CreateChild.	Listener
IsManaged	boolean	Specifies whether the action is managed. Valid values: true: The action is managed. You cannot perform the specified action on the managed instance. false: The action is not managed. You can perform the specified action on the managed instance.	false
Tags	array<object>	As tags anexadas ao grupo de endpoints.
	object	Uma tag do grupo de endpoints.
Key	string	The tag key.	test-key
Value	string	The tag value.	test-value
HealthCheckHost	string	O nome de domínio usado para verificações de integridade.	www.taobao.com
EndpointIpVersion	string	O protocolo IP do serviço de backend. Valores válidos: IPv4 (padrão): As conexões com o serviço de backend usam IPv4. IPv6: As conexões com o serviço de backend usam IPv6. ProtocolAffinity: A conexão com o serviço de backend usa o mesmo protocolo IP da solicitação do cliente.	IPv4
EndpointPrivateIpList	array<object>	Uma lista de endereços IP privados dos endpoints.
	object
PrivateIp	string	The private IP address.	172.19.115.37
VSwitchId	string	The ID of the vSwitch.	gsw-0jl6tmriqep1ga***
CIDR	string

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": ""
        }
      ]
    }
  ]
}

Códigos de erro

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

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.