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

Consulta 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 Global Accelerator. Defina o valor como cn-hangzhou.	cn-hangzhou
EndpointGroupId	string	Sim	O ID do grupo de endpoints.	epg-bp14sz7ftcwwjgrdm****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
HealthCheckIntervalSeconds	integer	O intervalo de verificação de integridade, em segundos.	3
TrafficPercentage	integer	A porcentagem de tráfego distribuída para o grupo de endpoints. Este parâmetro é retornado apenas quando um listener está associado a 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 ativos dos endpoints no grupo de endpoints. Importante Para um grupo de endpoints configurado para back-to-source a partir de uma rede privada, o console exibe apenas os endereços IP privados de back-to-source e não os endereços IP públicos. Se o tipo de conexão de rede para o serviço de backend do grupo de endpoints mudar (por exemplo, de uma rede privada para uma rede pública, ou para uma combinação de redes privadas e públicas), você deve monitorar as alterações nos endereços IP de back-to-source e atualizar a lista de controle de acesso (ACL) do serviço de backend de acordo.
	string	O endereço IP de um endpoint ativo.	101.XX.XX.22
EndpointGroupUnconfirmedIpList	array	Uma lista de endereços IP de endpoints pendentes de confirmação após uma atualização da instância do Global Accelerator.
	string	O endereço IP de um endpoint pendente de confirmação após uma atualização da instância do Global Accelerator.	101.XX.XX.22
RequestId	string	O ID da solicitação.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
HealthCheckPath	string	O caminho para as sondas de verificação de integridade.	/healthcheck
ThresholdCount	integer	O número de verificações de integridade com falha consecutivas antes que um endpoint seja marcado como não íntegro.	3
Name	string	O nome do grupo de endpoints.	group1
EndpointGroupRegion	string	O ID da região onde o grupo de endpoints está implantado.	cn-hangzhou
State	string	O status do grupo de endpoints. init: O grupo de endpoints está sendo inicializado. active: O grupo de endpoints está ativo. updating: O grupo de endpoints está sendo atualizado. deleting: O grupo de endpoints está sendo excluído.	active
HealthCheckProtocol	string	O protocolo usado para verificações de integridade. tcp ou TCP: TCP http ou HTTP: HTTP https ou HTTPS: HTTPS	tcp
HealthCheckPort	integer	A porta usada para verificações de integridade.	20
EndpointConfigurations	array<object>	As configurações de endpoint.
	object	Uma configuração de endpoint.
Type	string	O tipo do endpoint. Valores válidos: Domain: Um nome de domínio personalizado. Ip: Um endereço IP personalizado. IpTarget: Um endereço IP privado personalizado. PublicIp: Um endereço IP público do Alibaba Cloud. ECS: Uma instância ECS. SLB: Uma instância SLB. ALB: Uma instância ALB. OSS: Uma instância OSS. ENI: Uma interface de rede elástica. NLB: Uma instância NLB.	Ip
EnableClientIPPreservation	boolean	Indica se a preservação do IP do cliente está ativada usando o método automático. true: Ativado. false: Desativado.	false
Weight	integer	O peso do endpoint.	255
ProbeProtocol	string	O protocolo para 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	Indica se a preservação do IP do cliente está ativada usando o Proxy Protocol. true: Ativado. false: Desativado.	false
ProbePort	integer	A porta usada para sondagem de latência.	80
SubAddress	string	O endereço IP privado da interface de rede elástica.	172.168.XX.XX
VpcId	string	O ID da VPC.	vpc-hp30gtnxkfxj1l2xt****
VSwitchIds	array	Uma lista de IDs de VSwitch.
	string	O ID do VSwitch.	vsw-bp1nx4sxxe1nnr1ja****
Provider	string	O provedor da configuração de endpoint.	BAILIAN
ApiKeys	array	As chaves de API para a configuração de endpoint.
	string	Uma chave de API na configuração de endpoint.	sk-*******
PortOverrides	array<object>	A configuração de mapeamento de portas.
	object	Uma configuração de mapeamento de portas.
ListenerPort	integer	A porta do listener.	443
EndpointPort	integer	A porta do endpoint.	80
EndpointRequestProtocol	string	O protocolo usado pelo serviço de backend. Valores válidos: HTTP HTTPS	HTTP
EndpointProtocolVersion	string	A versão do protocolo do serviço de backend. Valores válidos: HTTP1.1 HTTP2	HTTP2
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
ForwardingRuleIds	array	Os IDs das regras de encaminhamento associadas.
	string	O ID da regra de encaminhamento.	frule-bp19a3t3yzr21q3****
AcceleratorId	string	O ID da instância do Global Accelerator.	ga-bp1odcab8tmno0hdq****
ListenerId	string	O ID do listener.	lsr-bp1bpn0kn908w4nbw****
SlsRegion	string	A região do projeto do Log Service.	cn-hangzhou
SlsProjectName	string	O nome do projeto do Log Service.	pn-01
SlsLogStoreName	string	O nome do Logstore.	lsn-01
AccessLogSwitch	string	O status da configuração do log de acesso. Valores válidos: on: O log de acesso está configurado. off: O log de acesso não está configurado. binding: O log de acesso está sendo configurado. unbinding: A configuração do log de acesso está sendo removida.	on
EnableAccessLog	boolean	Indica se o registro de log de acesso está ativado. true: O registro de log de acesso está ativado. false: O registro de log de acesso está desativado.	true
HealthCheckEnabled	boolean	Indica 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 serviço que gerencia a instância. Nota Este parâmetro é retornado apenas se ServiceManaged estiver definido como True.	ALB
ServiceManaged	boolean	Indica 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>	Uma lista de estados de gerenciamento para ações que podem ser executadas na instância. Nota Este parâmetro é retornado apenas se ServiceManaged estiver definido como True. Quando uma instância é gerenciada, algumas operações podem ser restritas.
	object	O estado de gerenciamento para uma ação específica.
Action	string	O nome da ação na instância gerenciada. Valores válidos: Create: Criar uma instância. Update: Atualizar a instância. Delete: Excluir a instância. Associate: Associar a instância. UserUnmanaged: Libera a instância do gerenciamento de serviço. CreateChild: Criar um recurso filho.	Update
ChildType	string	O tipo do recurso filho. Valores válidos: Listener: Um listener. IpSet: Uma região de aceleração. EndpointGroup: Um grupo de endpoints. ForwardingRule: Uma regra de encaminhamento. Endpoint: Um endpoint. EndpointGroupDestination: Um mapeamento de protocolo para um grupo de endpoints de um listener de roteamento personalizado. EndpointPolicy: Uma política de tráfego para um endpoint de um listener de roteamento personalizado. Nota Este parâmetro é válido apenas quando Action está definido como CreateChild.	Listener
IsManaged	boolean	Indica se a ação é gerenciada. Valores válidos: true: A ação é gerenciada. Você não pode executar esta ação na instância. false: A ação não é gerenciada. Você pode executar esta ação na instância.	false
Tags	array<object>	Uma lista de tags anexadas ao grupo de endpoints.
	object	Uma tag.
Key	string	A chave da tag.	test-key
Value	string	O valor da tag.	test-value
HealthCheckHost	string	O nome de domínio usado para verificações de integridade.	www.taobao.com
AccessLogRecordCustomizedHeadersEnabled	boolean	Especifica se devem ser registrados campos de cabeçalho personalizados nos logs de acesso. Valores válidos: true: Sim. false (padrão): Não. Nota Você pode definir este parâmetro como true apenas quando EnableAccessLog estiver definido como true.
AccessLogRecordCustomizedHeaderList	array	Os campos de cabeçalho personalizados a serem registrados nos logs de acesso.
	string	Um campo de cabeçalho personalizado a ser registrado nos logs de acesso.	['sda', 'dsaasdd', 'dsada']
EndpointIpVersion	string	A versão do IP usada para conectar ao serviço de backend. Valores válidos: IPv4 (padrão): O Global Accelerator conecta-se ao serviço de backend usando IPv4. IPv6: O Global Accelerator conecta-se ao serviço de backend usando IPv6. ProtocolAffinity: O Global Accelerator conecta-se ao serviço de backend usando a mesma versão de IP da solicitação do cliente.	IPv4
EndpointPrivateIpList	array<object>	Os endereços IP privados dos endpoints.
	object
PrivateIp	string	O endereço IP privado.	172.16.49.***
VSwitchId	string	O ID do VSwitch na VPC.	gsw-bp1rsfd2frym**
CIDR	string

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

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.	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.