ListEndpointGroups - - Centro de documentación de Alibaba Cloud

Consulta la lista de grupos de endpoint.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda invocar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListEndpointGroups	La operación que desea ejecutar. Establezca el valor en ListEndpointGroups.
RegionId	String	Sí	cn-hangzhou	El ID de la región donde se despliega la instancia de Global Accelerator (GA). Establezca el valor en cn-hangzhou.
PageNumber	Integer	No	1	El número de la página que se devuelve. Valor predeterminado: 1.
PageSize	Integer	No	10	La cantidad de entradas que se devuelven en cada página. Valor máximo: 50. Valor predeterminado: 10.
AcceleratorId	String	Sí	ga-bp1odcab8tmno0hdq****	El ID de la instancia de GA.
ListenerId	String	No	lsr-bp1bpn0kn908w4nbw****	El ID del listener.
EndpointGroupType	String	No	virtual	El tipo de grupo de endpoint. Valores válidos: default: un grupo de endpoint predeterminado. virtual: un grupo de endpoint virtual. Si deja este parámetro vacío, se consultan todos los grupos de endpoint predeterminados y virtuales.
AccessLogSwitch	String	No	on	Indica si la función de registro de accesos está habilitada. Valor predeterminado: off. Valores válidos: on: la función de registro de accesos está habilitada. off: la función de registro de accesos está deshabilitada.
EndpointGroupId	String	No	epg-bp16jdc00bhe97sr5****	El ID del grupo de endpoint.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
TotalCount	Integer	1	El número total de entradas devueltas.
PageSize	Integer	10	La cantidad de entradas devueltas por página.
RequestId	String	A052D49E-CCC2-41DB-816C-DC3381503194	El ID de la solicitud.
PageNumber	Integer	1	El número de la página devuelta.
EndpointGroups	Array of EndpointGroups		Las configuraciones del grupo de endpoint.
EndpointGroupId	String	epg-bp16jdc00bhe97sr5****	El ID de un grupo de endpoint.
EndpointGroupIpList	Array of String	47.1.XX.XX	La lista de direcciones IP del grupo de endpoint.
EndpointGroupUnconfirmedIpList	Array of String	47.1.XX.XX	Las direcciones IP del grupo de endpoint que se deben confirmar después de actualizar la instancia de GA.
State	String	active	El estado del grupo de endpoint. Valores válidos: init: el grupo de endpoint se está inicializando. active: el grupo de endpoint funciona con normalidad. updating: el grupo de endpoint se está actualizando. deleteing: el grupo de endpoint se está eliminando.
HealthCheckPath	String	/healthcheck	La ruta a la que se envían las solicitudes de comprobación de estado.
EndpointGroupRegion	String	cn-hangzhou	El ID de la región donde se despliega el grupo de endpoint.
HealthCheckIntervalSeconds	Integer	3	El intervalo con el que se ejecutan las comprobaciones de estado. Unidad: segundos.
TrafficPercentage	Integer	20	El peso del grupo de endpoint cuando el listener se asocia con varios grupos de endpoint.
HealthCheckProtocol	String	tcp	El protocolo mediante el cual se envían las solicitudes de comprobación de estado. Valores válidos: tcp: TCP. http: HTTP. https: HTTPS.
ThresholdCount	Integer	3	La cantidad de comprobaciones de estado consecutivas con errores que deben ocurrir antes de considerar un endpoint como no saludable.
ListenerId	String	lsr-bp1bpn0kn908w4nbw****	El ID del listener.
AcceleratorId	String	ga-bp1odcab8tmno0hdq****	El ID de la instancia de GA.
EndpointConfigurations	Array of EndpointConfigurations		Las configuraciones del endpoint.
Type	String	Ip	El tipo de endpoint. Valores válidos: Domain: un nombre de dominio personalizado. Ip: una dirección IP personalizada. PublicIp: una dirección IP pública proporcionada por Alibaba Cloud. ECS: una instancia de Elastic Compute Service (ECS). SLB: una instancia de Server Load Balancer (SLB). ALB: una instancia de Application Load Balancer (ALB). OSS: un bucket de Object Storage Service (OSS).
EnableClientIPPreservation	Boolean	false	Indica si la función de conservación de la dirección IP del cliente está habilitada. Valores válidos: true: la función de conservación de la dirección IP del cliente está habilitada. false: la función de conservación de la dirección IP del cliente está deshabilitada.
Weight	Integer	20	El peso del endpoint.
ProbeProtocol	String	tcp	El protocolo que se usa para supervisar la latencia. Valores válidos: icmp: ICMP. tcp: TCP.
Endpoint	String	47.1.XX.XX	La dirección IP o el nombre de dominio del endpoint.
ProbePort	Integer	80	El puerto que se usa para supervisar la latencia.
EndpointId	String	ep-bp1d2utp8qqe2a44t****	El ID del endpoint.
PortOverrides	Array of PortOverrides		Las asignaciones entre puertos.
ListenerPort	Integer	443	El puerto del listener.
EndpointPort	Integer	80	El puerto del endpoint.
ForwardingRuleIds	Array of String	frule-bp19a3t3yzr21q3****	El ID de la regla de reenvío asociada al grupo de endpoint.
EndpointGroupType	String	default	El tipo de grupo de endpoint. Valores válidos: default: un grupo de endpoint predeterminado. virtual: un grupo de endpoint virtual.
EndpointRequestProtocol	String	HTTP	El protocolo que utiliza el servicio de backend. Valores válidos: HTTP: HTTP. HTTPS: HTTPS.
Description	String	group1	La descripción del grupo de endpoint.
Name	String	group1	El nombre del grupo de endpoint.
HealthCheckPort	Integer	10	El puerto que se usa para las comprobaciones de estado.
HealthCheckEnabled	Boolean	true	Indica si la función de comprobación de estado está habilitada. Valores válidos: true: la función de comprobación de estado está habilitada. false: la función de comprobación de estado está deshabilitada.

Ejemplos

Solicitudes de ejemplo

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>

Respuestas exitosas de ejemplo

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 error

Para consultar la lista de códigos de error, visite el centro de errores de API.