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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListEndpointGroups	Operação a ser executada. Defina o valor como ListEndpointGroups.
RegionId	String	Sim	cn-hangzhou	ID da região onde a instância do Global Accelerator (GA) está implantada. Defina o valor como cn-hangzhou.
PageNumber	Integer	Não	1	Número da página a retornar. Valor padrão: 1.
PageSize	Integer	Não	10	Quantidade de entradas por página. Valor máximo: 50. Valor padrão: 10.
AcceleratorId	String	Sim	ga-bp1odcab8tmno0hdq****	ID da instância do GA.
ListenerId	String	Não	lsr-bp1bpn0kn908w4nbw****	ID do listener.
EndpointGroupType	String	Não	virtual	Tipo do grupo de endpoints. Valores válidos: default: grupo de endpoints padrão. virtual: grupo de endpoints virtual. Se este parâmetro estiver vazio, a consulta retorna todos os grupos de endpoints padrão e virtuais.
AccessLogSwitch	String	Não	on	Indica se o recurso de log de acesso está ativado. Valor padrão: off. Valores válidos: on: recurso de log de acesso ativado. off: recurso de log de acesso desativado.
EndpointGroupId	String	Não	epg-bp16jdc00bhe97sr5****	ID do grupo de endpoints.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	Integer	1	Número total de entradas retornadas.
PageSize	Integer	10	Quantidade de entradas retornadas por página.
RequestId	String	A052D49E-CCC2-41DB-816C-DC3381503194	ID da solicitação.
PageNumber	Integer	1	Número da página retornada.
EndpointGroups	Array of EndpointGroups		Configurações do grupo de endpoints.
EndpointGroupId	String	epg-bp16jdc00bhe97sr5****	ID do grupo de endpoints.
EndpointGroupIpList	Array of String	47.1.XX.XX	Lista de endereços IP do grupo de endpoints.
EndpointGroupUnconfirmedIpList	Array of String	47.1.XX.XX	Endereços IP do grupo de endpoints pendentes de confirmação após a atualização da instância do GA.
State	String	active	Estado do grupo de endpoints. Valores válidos: init: inicializando o grupo de endpoints. active: grupo de endpoints em funcionamento normal. updating: atualizando o grupo de endpoints. deleteing: excluindo o grupo de endpoints.
HealthCheckPath	String	/healthcheck	Caminho de destino das solicitações de verificação de integridade.
EndpointGroupRegion	String	cn-hangzhou	ID da região onde o grupo de endpoints está implantado.
HealthCheckIntervalSeconds	Integer	3	Intervalo entre verificações de integridade. Unidade: segundos.
TrafficPercentage	Integer	20	Peso do grupo de endpoints quando o listener está associado a vários grupos.
HealthCheckProtocol	String	tcp	Protocolo das solicitações de verificação de integridade. Valores válidos: tcp: TCP http: HTTP https: HTTPS
ThresholdCount	Integer	3	Número de falhas consecutivas na verificação de integridade necessárias para considerar um endpoint não íntegro.
ListenerId	String	lsr-bp1bpn0kn908w4nbw****	ID do listener.
AcceleratorId	String	ga-bp1odcab8tmno0hdq****	ID da instância do GA.
EndpointConfigurations	Array of EndpointConfigurations		Configurações do endpoint.
Type	String	Ip	Tipo do endpoint. Valores válidos: Domain: nome de domínio personalizado. Ip: endereço IP personalizado. PublicIp: endereço IP público fornecido pela Alibaba Cloud. ECS: instância do Elastic Compute Service (ECS). SLB: instância do Server Load Balancer (SLB). ALB: instância do Application Load Balancer (ALB). OSS: bucket do Object Storage Service (OSS).
EnableClientIPPreservation	Boolean	false	Indica se o recurso de preservação de IP do cliente está ativado. Valores válidos: true: recurso de preservação de IP do cliente ativado. false: recurso de preservação de IP do cliente desativado.
Weight	Integer	20	Peso do endpoint.
ProbeProtocol	String	tcp	Protocolo usado para monitorar a latência. Valores válidos: icmp: ICMP tcp: TCP
Endpoint	String	47.1.XX.XX	Endereço IP ou nome de domínio do endpoint.
ProbePort	Integer	80	Porta usada para monitorar a latência.
EndpointId	String	ep-bp1d2utp8qqe2a44t****	ID do endpoint.
PortOverrides	Array of PortOverrides		Mapeamentos entre portas.
ListenerPort	Integer	443	Porta do listener.
EndpointPort	Integer	80	Porta do endpoint.
ForwardingRuleIds	Array of String	frule-bp19a3t3yzr21q3****	ID da regra de encaminhamento associada ao grupo de endpoints.
EndpointGroupType	String	default	Tipo do grupo de endpoints. Valores válidos: default: grupo de endpoints padrão. virtual: grupo de endpoints virtual.
EndpointRequestProtocol	String	HTTP	Protocolo usado pelo serviço de backend. Valores válidos: HTTP: HTTP HTTPS: HTTPS
Description	String	group1	Descrição do grupo de endpoints.
Name	String	group1	Nome do grupo de endpoints.
HealthCheckPort	Integer	10	Porta usada para verificações de integridade.
HealthCheckEnabled	Boolean	true	Indica se o recurso de verificação de integridade está ativado. Valores válidos: true: recurso de verificação de integridade ativado. false: recurso de verificação de integridade desativado.

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=ListEndpointGroups
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&EndpointGroupType=virtual
&AccessLogSwitch=on
&EndpointGroupId=epg-bp16jdc00bhe97sr5****
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListEndpointGroupsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>A052D49E-CCC2-41DB-816C-DC3381503194	</RequestId>
    <PageNumber>1</PageNumber>
    <EndpointGroups>
        <EndpointGroupId>epg-bp16jdc00bhe97sr5****</EndpointGroupId>
        <EndpointGroupIpList>47.1.XX.XX</EndpointGroupIpList>
        <EndpointGroupUnconfirmedIpList>47.1.XX.XX</EndpointGroupUnconfirmedIpList>
        <State>active</State>
        <HealthCheckPath>/healthcheck</HealthCheckPath>
        <EndpointGroupRegion>cn-hangzhou</EndpointGroupRegion>
        <HealthCheckIntervalSeconds>3</HealthCheckIntervalSeconds>
        <TrafficPercentage>20</TrafficPercentage>
        <HealthCheckProtocol>tcp</HealthCheckProtocol>
        <ThresholdCount>3</ThresholdCount>
        <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
        <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>
        <EndpointConfigurations>
            <Type>Ip</Type>
            <EnableClientIPPreservation>false</EnableClientIPPreservation>
            <Weight>20</Weight>
            <ProbeProtocol>tcp</ProbeProtocol>
            <Endpoint>47.1.XX.XX</Endpoint>
            <ProbePort>80</ProbePort>
            <EndpointId>ep-bp1d2utp8qqe2a44t****</EndpointId>
        </EndpointConfigurations>
        <PortOverrides>
            <ListenerPort>443</ListenerPort>
            <EndpointPort>80</EndpointPort>
        </PortOverrides>
        <ForwardingRuleIds>frule-bp19a3t3yzr21q3****</ForwardingRuleIds>
        <EndpointGroupType>default</EndpointGroupType>
        <EndpointRequestProtocol>HTTP</EndpointRequestProtocol>
        <Description>group1</Description>
        <Name>group1</Name>
        <HealthCheckPort>10</HealthCheckPort>
        <HealthCheckEnabled>true</HealthCheckEnabled>
    </EndpointGroups>
</ListEndpointGroupsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : 20,
    "HealthCheckProtocol" : "tcp",
    "ThresholdCount" : 3,
    "ListenerId" : "lsr-bp1bpn0kn908w4nbw****",
    "AcceleratorId" : "ga-bp1odcab8tmno0hdq****",
    "EndpointConfigurations" : [ {
      "Type" : "Ip",
      "EnableClientIPPreservation" : false,
      "Weight" : 20,
      "ProbeProtocol" : "tcp",
      "Endpoint" : "47.1.XX.XX",
      "ProbePort" : 80,
      "EndpointId" : "ep-bp1d2utp8qqe2a44t****"
    } ],
    "PortOverrides" : [ {
      "ListenerPort" : 443,
      "EndpointPort" : 80
    } ],
    "ForwardingRuleIds" : [ "frule-bp19a3t3yzr21q3****" ],
    "EndpointGroupType" : "default",
    "EndpointRequestProtocol" : "HTTP",
    "Description" : "group1",
    "Name" : "group1",
    "HealthCheckPort" : 10,
    "HealthCheckEnabled" : true
  } ]
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.