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

Consulta os detalhes de um grupo de endpoints especificado.

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:DescribeEndpointGroup

get

*EndpointGroup.

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

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
EndpointGroupId	string	Sim	O ID do grupo de endpoints que você deseja consultar.	epg-bp14sz7ftcwwjgrdm****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A lista de informações de resposta.
HealthCheckIntervalSeconds	integer	O intervalo entre as verificações de integridade, em segundos.	3
TrafficPercentage	integer	A porcentagem de tráfego roteada para diferentes grupos de endpoints quando um listener possui vários grupos de endpoints.	100
EndpointGroupId	string	O ID do grupo de endpoints.	epg-bp14sz7ftcwwjgrdm****
Description	string	A descrição do grupo de endpoints.	group1
EndpointGroupIpList	array	A lista de endereços IP de endpoints ativos no grupo de endpoints. Importante Para grupos de endpoints que usam roteamento de retorno à origem por rede privada, o console exibe apenas os endereços de retorno à origem da rede privada e não exibe mais os endereços de rede pública. Se o tipo de conectividade de rede do serviço de backend no grupo de endpoints mudar, como de uma rede privada para uma rede pública, ou para um híbrido de redes públicas e privadas, monitore as mudanças nos endereços de retorno à origem prontamente e execute a sincronização da lista de ACL do serviço de backend.
	string	Um endereço IP de endpoint ativo no grupo de endpoints.	101.XX.XX.22
EndpointGroupUnconfirmedIpList	array	A lista de novos endereços IP do grupo de endpoints 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 pendentes de confirmação após a atualização da instância do Alibaba Cloud Global Accelerator (GA).	101.XX.XX.22
RequestId	string	O ID da solicitação.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
HealthCheckPath	string	O caminho da verificação de integridade.	/healthcheck
ThresholdCount	integer	O número de verificações de integridade com falha consecutivas necessárias para marcar um endpoint como não íntegro.	3
Name	string	O nome do grupo de endpoints.	group1
EndpointGroupRegion	string	O ID da região à qual o grupo de endpoints pertence.	cn-hangzhou
State	string	O estado do grupo de endpoints. Valores válidos: init: Inicializando. active: Normal. updating: Atualizando. deleting: Excluindo.	active
HealthCheckProtocol	string	O protocolo de verificação de integridade. Valores válidos: tcp ou TCP: Protocolo TCP. http ou HTTP: Protocolo HTTP. https ou HTTPS: Protocolo HTTPS.	tcp
HealthCheckPort	integer	A porta de verificação de integridade.	20
EndpointConfigurations	array<object>	As configurações do endpoint.
	object	As configurações do endpoint.
Type	string	O tipo de endpoint. Valores válidos: Domain: Nome de domínio personalizado. Ip: Endereço IP personalizado. IpTarget: Endereço IP privado personalizado. PublicIp: Endereço IP público do Alibaba Cloud. ECS: Instância ECS do Alibaba Cloud. SLB: Instância SLB do Alibaba Cloud. ALB: Instância ALB do Alibaba Cloud. OSS: Instância OSS do Alibaba Cloud. ENI: Interfaces de rede elásticas (ENIs) do Alibaba Cloud, que atuam como controlador de interface de rede (NIC). NLB: Instância NLB do Alibaba Cloud.	Ip
EnableClientIPPreservation	boolean	Especifica se a preservação do endereço IP do cliente está ativada usando o método de recuperação automática. Valores válidos: true: A preservação do endereço IP do cliente está ativada. false: A preservação do endereço IP do cliente está desativada.	false
Weight	integer	O peso do endpoint.	255
ProbeProtocol	string	O protocolo de sondagem de latência. Valores válidos: tcp: TCP. icmp: ICMP.	tcp
Endpoint	string	O endereço IP, nome de domínio ou ID da instância do endpoint.	120.XX.XX.21
EnableProxyProtocol	boolean	Especifica se a preservação do endereço IP do cliente está ativada usando o Proxy Protocol. Valores válidos: true: A preservação do endereço IP do cliente está ativada usando o Proxy Protocol. false: A preservação do endereço IP do cliente não está ativada usando o Proxy Protocol.	false
ProbePort	integer	A porta de sondagem para monitoramento de latência.	80
SubAddress	string	O endereço IP privado da interface de rede elástica (ENI).	172.168.XX.XX
VpcId	string	O ID da nuvem privada virtual (VPC).	vpc-hp30gtnxkfxj1l2xt****
VSwitchIds	array	A lista de vSwitches na VPC.
	string	O ID do vSwitch.	vsw-bp1nx4sxxe1nnr1ja****
Provider	string	O provedor de configuração.	BAILIAN
ApiKeys	array	As chaves de API na configuração do endpoint.
	string	A primeira chave de API na configuração do endpoint.	sk-*******
PortOverrides	array<object>	Os relacionamentos de mapeamento de portas.
	object	Os relacionamentos de mapeamento de portas.
ListenerPort	integer	A porta do listener.	443
EndpointPort	integer	A porta do endpoint.	80
EndpointRequestProtocol	string	O protocolo do serviço de backend. Isso se refere ao protocolo de rede, não aos Termos de Serviço. Valores válidos: HTTP HTTPS	HTTP
EndpointProtocolVersion	string	A versão do protocolo do serviço de backend. Isso se refere à versão do protocolo de rede, não aos Termos de Serviço. Valores válidos: HTTP1.1 HTTP2	HTTP2
EndpointGroupType	string	O tipo de grupo de endpoints. Valores válidos: default: Grupo de endpoints padrão. virtual: Grupo de endpoints virtual.	default
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****
AcceleratorId	string	O ID da instância do Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	O ID da instância do listener.	lsr-bp1bpn0kn908w4nbw****
SlsRegion	string	A região do Simple Log Service.	cn-hangzhou
SlsProjectName	string	O nome do projeto do Simple Log Service.	pn-01
SlsLogStoreName	string	O nome do Logstore do Simple Log Service.	lsn-01
AccessLogSwitch	string	O status de vinculação do log. Valores válidos: on: Vinculado. off: Não vinculado. binding: Vinculando. unbinding: Desvinculando.	on
EnableAccessLog	boolean	Especifica se o log de acesso está ativado. Valores válidos: true: O log de acesso está ativado. false: O log de acesso está desativado.	true
HealthCheckEnabled	boolean	Especifica se as verificações de integridade estão ativadas. Valores válidos: 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 lista de políticas de ação que os usuários podem executar na instância gerenciada.
Action	string	O nome da ação da política gerenciada. Valores válidos: 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 a instância do gerenciamento. CreateChild: Criar um recurso filho sob a instância atual.	Update
ChildType	string	O tipo de recurso filho. Valores válidos: 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: Recurso de mapeamento de protocolo de grupo de endpoints sob um listener de roteamento personalizado. EndpointPolicy: Recurso de política de acesso de 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 as 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 para verificações de integridade.	www.taobao.com
AccessLogRecordCustomizedHeadersEnabled	boolean	Especifica se os logs de acesso carregam campos de cabeçalho personalizados. Valores válidos: true: Sim. false (padrão): Não. Nota Você pode definir este parâmetro como true apenas quando a chave de log de acesso AccessLogEnabled para a instância estiver ativada.
AccessLogRecordCustomizedHeaderList	array	A lista de nomes de campos de cabeçalho personalizados carregados nos logs de acesso.
	string	A lista de nomes de campos de cabeçalho personalizados carregados nos logs de acesso.	['sda', 'dsaasdd', 'dsada']
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 nas solicitações 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.16.49.***
VSwitchId	string	O ID do vSwitch na VPC.	gsw-bp1rsfd2frym**
CIDR	string	O bloco CIDR na lista de IPs de endpoints privados.	10.0.0.0/24
HealthCheckSuccessCodes	string	Os códigos de status de sucesso para verificações de integridade.	http_2xx,http_3xx
HealthCheckMethod	string	O método de verificação de integridade.	GET
ProxyTunnel	object	A configuração do túnel de proxy.
ConnectAuthPrefix	string	O prefixo de autenticação de conexão.	prefix-auth
ConnectAuthSuffix	string	O sufixo de autenticação de conexão.	suffix-auth
ConnectSessionHashHdr	string	O cabeçalho de hash de sessão de conexão.	X-Session-Hash
ConnectTunnelTimeout	integer	O período de tempo limite do túnel de conexão.	5000
TunnelServerPort	integer	A porta do servidor de túnel.	8443
TunnelServerType	string	O tipo de servidor de túnel.	domain
TunnelServer	string	A configuração do servidor de túnel.	tunnel.example.com

Exemplos

Resposta de sucesso

JSON formato

{
  "HealthCheckIntervalSeconds": 3,
  "TrafficPercentage": 100,
  "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
  "Description": "group1",
  "EndpointGroupIpList": [
    "101.XX.XX.22"
  ],
  "EndpointGroupUnconfirmedIpList": [
    "101.XX.XX.22"
  ],
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "HealthCheckPath": "/healthcheck",
  "ThresholdCount": 3,
  "Name": "group1",
  "EndpointGroupRegion": "cn-hangzhou",
  "State": "active",
  "HealthCheckProtocol": "tcp",
  "HealthCheckPort": 20,
  "EndpointConfigurations": [
    {
      "Type": "Ip",
      "EnableClientIPPreservation": false,
      "Weight": 255,
      "ProbeProtocol": "tcp",
      "Endpoint": "120.XX.XX.21",
      "EnableProxyProtocol": false,
      "ProbePort": 80,
      "SubAddress": "172.168.XX.XX",
      "VpcId": "vpc-hp30gtnxkfxj1l2xt****",
      "VSwitchIds": [
        "vsw-bp1nx4sxxe1nnr1ja****"
      ],
      "Provider": "BAILIAN",
      "ApiKeys": [
        "sk-*******"
      ]
    }
  ],
  "PortOverrides": [
    {
      "ListenerPort": 443,
      "EndpointPort": 80
    }
  ],
  "EndpointRequestProtocol": "HTTP",
  "EndpointProtocolVersion": "HTTP2",
  "EndpointGroupType": "default",
  "ForwardingRuleIds": [
    "frule-bp19a3t3yzr21q3****"
  ],
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "SlsRegion": "cn-hangzhou",
  "SlsProjectName": "pn-01",
  "SlsLogStoreName": "lsn-01",
  "AccessLogSwitch": "on",
  "EnableAccessLog": true,
  "HealthCheckEnabled": true,
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ],
  "Tags": [
    {
      "Key": "test-key",
      "Value": "test-value"
    }
  ],
  "HealthCheckHost": "www.taobao.com",
  "AccessLogRecordCustomizedHeadersEnabled": false,
  "AccessLogRecordCustomizedHeaderList": [
    "['sda', 'dsaasdd', 'dsada']"
  ],
  "EndpointIpVersion": "IPv4",
  "EndpointPrivateIpList": [
    {
      "PrivateIp": "172.16.49.***",
      "VSwitchId": "gsw-bp1rsfd2frym**",
      "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
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.