ListEndpointGroups - Global Accelerator - Centro de documentación de Alibaba Cloud

Consulta los grupos de endpoints.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ga:ListEndpointGroups

list

*EndpointGroup.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la instancia de Global Accelerator. Establezca el valor en cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página para una consulta paginada. Valor máximo: 50. Valor predeterminado: 10.	10
AcceleratorId	string	Sí	El ID de la instancia de Global Accelerator.	ga-bp1odcab8tmno0hdq****
ListenerId	string	No	El ID de la instancia de listener.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupType	string	No	El tipo de grupo de endpoints. Valores válidos: default: el grupo de endpoints predeterminado. virtual: el grupo de endpoints virtual. Valor vacío: todos los grupos de endpoints predeterminados y virtuales. Valores válidos: default : El grupo de endpoints predeterminado. virtual : El grupo de endpoints virtual.	virtual
AccessLogSwitch	string	No	Especifica si se debe habilitar la función de registro de acceso. Valores válidos: on: habilita la función de registro de acceso. off: deshabilita la función de registro de acceso. Este es el valor predeterminado.	on
EndpointGroupId	string	No	El ID del grupo de endpoints.	epg-bp16jdc00bhe97sr5****
Tag	array<object>	No	Las etiquetas del grupo de endpoints.
	object	No	Las etiquetas del grupo de endpoints.
Key	string	No	La clave de etiqueta del grupo de endpoints. La clave de etiqueta no puede ser una cadena vacía. Puede tener una longitud de hasta 64 caracteres y no puede comenzar con `aliyun` ni con `acs:`. No puede contener `http://` ni `https://`. Puede especificar hasta 20 claves de etiqueta.	test-key
Value	string	No	El valor de etiqueta del grupo de endpoints. El valor de etiqueta puede ser una cadena vacía. Puede tener una longitud de hasta 128 caracteres y no puede comenzar con `aliyun` ni con `acs:`. No puede contener `http://` ni `https://`. Puede especificar hasta 20 valores de etiqueta.	test-value
EndpointGroupRegion	string	No

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La lista de información de respuesta.
TotalCount	integer	El número total de entradas en la lista.	1
PageSize	integer	El número de entradas devueltas por página durante la paginación en una consulta paginada.	10
RequestId	string	El ID de la solicitud.	A052D49E-CCC2-41DB-816C-DC3381503194
PageNumber	integer	El número de página de la lista.	1
EndpointGroups	array<object>	La información de configuración de los grupos de endpoints.
	array<object>	La información de configuración de los grupos de endpoints.
EndpointGroupId	string	El ID del grupo de endpoints.	epg-bp16jdc00bhe97sr5****
EndpointGroupIpList	array	La lista de direcciones IP públicas salientes del grupo de endpoints. Importante Para los grupos de endpoints que utilizan enrutamiento de retorno al origen por red privada, la consola muestra solo las direcciones privadas de retorno al origen y ya no muestra las direcciones públicas. Si el tipo de conectividad de red del servicio backend en un grupo de endpoints cambia, por ejemplo, de una red privada a una red pública, o a una combinación de redes públicas y privadas, supervise los cambios en las direcciones de retorno al origen y asegúrese de que haya sincronización al actualizar la lista de control de acceso (ACL) del servicio backend.
	string	Una dirección IP pública saliente del grupo de endpoints.	47.1.XX.XX
EndpointGroupUnconfirmedIpList	array	La lista de nuevas direcciones IP del grupo de endpoints que están pendientes de confirmación después de actualizar la instancia de Alibaba Cloud Global Accelerator (GA).
	string	La lista de nuevas direcciones IP del grupo de endpoints que están pendientes de confirmación después de actualizar la instancia de Alibaba Cloud Global Accelerator (GA).	47.1.XX.XX
State	string	El estado del grupo de endpoints. Valores válidos: init: inicializando active: normal updating: actualizando deleteing: eliminando	active
HealthCheckPath	string	La ruta de la comprobación de estado.	/healthcheck
EndpointGroupRegion	string	El ID de la región a la que pertenece el grupo de endpoints.	cn-hangzhou
HealthCheckIntervalSeconds	integer	El intervalo entre dos comprobaciones de estado consecutivas. Unidad: segundos.	3
TrafficPercentage	integer	El porcentaje de tráfico enrutado al grupo de endpoints cuando un listener está asociado con varios grupos de endpoints.	100
HealthCheckProtocol	string	El protocolo de comprobación de estado. Valores válidos: tcp o TCP: TCP http o HTTP: HTTP https o HTTPS: HTTPS	tcp
ThresholdCount	integer	El número de comprobaciones de estado fallidas consecutivas necesarias para marcar un endpoint como no saludable.	3
ListenerId	string	El ID de la instancia del listener.	lsr-bp1bpn0kn908w4nbw****
AcceleratorId	string	El ID de la instancia de Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
EndpointConfigurations	array<object>	La información de configuración del endpoint.
	object	La información de configuración del endpoint.
Type	string	El tipo de endpoint. Valores válidos: Domain: nombre de dominio personalizado Ip: dirección IP personalizada IpTarget: IP privada personalizada PublicIp: dirección IP pública de Alibaba Cloud ECS: instancia de ECS SLB: instancia de SLB ALB: instancia de ALB OSS: instancia de OSS ENI: controlador de interfaz de red elástica (NIC) de Alibaba Cloud NLB: instancia de NLB	Ip
EnableClientIPPreservation	boolean	Especifica si la conservación de la dirección IP del cliente está habilitada mediante el método de recuperación automática. Valores válidos: true: La conservación de la dirección IP del cliente está habilitada. false: La conservación de la dirección IP del cliente está deshabilitada.	false
Weight	integer	El peso del endpoint.	20
ProbeProtocol	string	El protocolo de sondeo para el monitoreo de latencia. Valores válidos: icmp: ICMP tcp: TCP	tcp
Endpoint	string	La dirección IP, el nombre de dominio o el ID de la instancia del endpoint.	47.1.XX.XX
EnableProxyProtocol	boolean	Especifica si la conservación de la dirección IP del cliente está habilitada mediante Proxy Protocol. Valores válidos: true: La conservación de la dirección IP del cliente está habilitada mediante Proxy Protocol. false: La conservación de la dirección IP del cliente no está habilitada mediante Proxy Protocol.
ProbePort	integer	El puerto de sondeo para el monitoreo de latencia.	80
EndpointId	string	El ID del endpoint.	ep-bp1d2utp8qqe2a44t****
SubAddress	string	La IP privada del controlador de interfaz de red elástica (NIC).	172.168.XX.XX
VpcId	string	El ID de la VPC.	vpc-8vbhucmd5b2q2fpqqu****
VSwitchIds	array	La lista de vSwitches en la VPC.
	string	El ID del vSwitch.	vsw-hp3xwc2aebg2u30ln****
Provider	string	La información del proveedor.	BAILIAN
ApiKeys	array	Las claves de API en la configuración del endpoint.
	string	La primera clave de API en el grupo de endpoints.	sk-*******
PortOverrides	array<object>	Las relaciones de asignación de puertos.
	object	Las relaciones de asignación de puertos.
ListenerPort	integer	El puerto del listener.	443
EndpointPort	integer	El puerto del endpoint.	80
ForwardingRuleIds	array	Los ID de las reglas de reenvío asociadas con el grupo de endpoints.
	string	Los ID de las reglas de reenvío asociadas con el grupo de endpoints.	frule-bp19a3t3yzr21q3****
EndpointGroupType	string	El tipo de grupo de endpoints. Valores válidos: default: grupo de endpoints predeterminado virtual: grupo de endpoints virtual	default
EndpointRequestProtocol	string	El protocolo del servicio backend. Valores válidos: HTTP: HTTP HTTPS: HTTPS	HTTP
EndpointProtocolVersion	string	La versión del protocolo del servicio backend. Valores válidos: HTTP1.1: HTTP1.1 HTTP2: HTTP2	HTTP1.1
Description	string	La descripción del grupo de endpoints.	group1
Name	string	El nombre del grupo de endpoints.	group1
HealthCheckPort	integer	El puerto de comprobación de estado.	10
HealthCheckEnabled	boolean	Especifica si las comprobaciones de estado están habilitadas. Valores válidos: true: Las comprobaciones de estado están habilitadas. false: Las comprobaciones de estado están deshabilitadas.	true
ServiceId	string	El ID del proveedor de servicios al que pertenece la instancia administrada. Nota Este parámetro solo es válido cuando el parámetro ServiceManaged se establece en true.	ALB
ServiceManaged	boolean	Especifica si la instancia es una instancia administrada. Valores válidos: true: La instancia es una instancia administrada. false: La instancia no es una instancia administrada.	true
ServiceManagedInfos	array<object>	La lista de políticas de acción que los usuarios pueden ejecutar en la instancia administrada. Nota Este parámetro solo es válido cuando el parámetro ServiceManaged se establece en true. Cuando una instancia está en estado administrado, las operaciones de los usuarios en la instancia están restringidas y ciertas operaciones están prohibidas.
	object	Una política de acción que los usuarios pueden ejecutar en la instancia administrada.
Action	string	El nombre de la acción de la política administrada. Valores válidos: Create: crear una instancia Update: actualizar la instancia actual Delete: eliminar la instancia actual Associate: hacer referencia a la instancia actual o ser referenciada por esta UserUnmanaged: dejar de administrar la instancia CreateChild: crear un recurso secundario bajo la instancia actual	Update
ChildType	string	El tipo de recurso secundario. Valores válidos: Listener: recurso de listener IpSet: recurso de región de aceleración EndpointGroup: recurso de grupo de endpoints ForwardingRule: recurso de regla de reenvío Endpoint: recurso de endpoint EndpointGroupDestination: recurso de asignación de protocolo de grupo de endpoints bajo un listener de enrutamiento personalizado EndpointPolicy: recurso de política de acceso de endpoint bajo un listener de enrutamiento personalizado Nota Este parámetro solo es válido cuando el parámetro Action se establece en CreateChild.	Listener
IsManaged	boolean	Especifica si la acción de la política administrada está administrada. Valores válidos: true: La acción de la política administrada está administrada. Los usuarios no tienen los permisos para realizar la operación especificada por Action en la instancia administrada. false: La acción de la política administrada no está administrada. Los usuarios pueden realizar la operación especificada por Action en la instancia administrada.	false
Tags	array<object>	Las etiquetas del grupo de endpoints.
	object	Las etiquetas del grupo de endpoints.
Key	string	La clave de etiqueta del grupo de endpoints.	test-key
Value	string	El valor de etiqueta del grupo de endpoints.	test-value
HealthCheckHost	string	El nombre de dominio de comprobación de estado.	www.taobao.com
EndpointIpVersion	string	El protocolo de dirección IP del backend. Valores válidos: IPv4: GA utiliza solo direcciones IPv4 para comunicarse con el servicio de endpoint. Este es el valor predeterminado. IPv6: GA utiliza solo direcciones IPv6 para comunicarse con el servicio de endpoint. ProtocolAffinity: GA utiliza el mismo protocolo IP para comunicarse con el servicio de endpoint que el protocolo IP utilizado por las solicitudes del cliente.	IPv4
EndpointPrivateIpList	array<object>	La lista de direcciones IP privadas de los nodos backend.
	object
PrivateIp	string	La dirección IP privada.	172.19.115.37
VSwitchId	string	El ID del vSwitch en la VPC.	gsw-0jl6tmriqep1ga***
CIDR	string
HealthCheckSuccessCodes	string
HealthCheckMethod	string
ProxyTunnel	object
ConnectAuthPrefix	string
ConnectAuthSuffix	string
ConnectSessionHashHdr	string
ConnectTunnelTimeout	integer
TunnelServerPort	integer
TunnelServerType	string
TunnelServer	string

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "A052D49E-CCC2-41DB-816C-DC3381503194",
  "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": "clave-de-prueba",
          "Value": "valor-de-prueba"
        }
      ],
      "HealthCheckHost": "www.taobao.com",
      "EndpointIpVersion": "IPv4",
      "EndpointPrivateIpList": [
        {
          "PrivateIp": "172.19.115.37",
          "VSwitchId": "gsw-0jl6tmriqep1ga***",
          "CIDR": ""
        }
      ],
      "HealthCheckSuccessCodes": "",
      "HealthCheckMethod": "",
      "ProxyTunnel": {
        "ConnectAuthPrefix": "",
        "ConnectAuthSuffix": "",
        "ConnectSessionHashHdr": "",
        "ConnectTunnelTimeout": 0,
        "TunnelServerPort": 0,
        "TunnelServerType": "",
        "TunnelServer": ""
      }
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	NoPermission	No permissions.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.