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

Modifica grupos de endpoints para un listener en lote.

Descripción de la operación

Notas de uso

UpdateEndpointGroups es una operación asíncrona. Después de enviar una solicitud, el sistema devuelve un ID de solicitud, pero la operación continúa ejecutándose en segundo plano. Puede llamar a la operación o para consultar el estado de un grupo de endpoints.
- Si un grupo de endpoints está en estado updating, su configuración se está modificando. En este estado, solo puede realizar operaciones de consulta.
- Si un grupo de endpoints está en estado active, su configuración se ha modificado.
No puede llamar simultáneamente a la operación UpdateEndpointGroups para modificar las configuraciones de grupos de endpoints que pertenecen a la misma instancia de Global Accelerator (GA).

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

update

*EndpointGroup

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de región de la instancia de GA. Establezca el valor en cn-hangzhou.	cn-hangzhou
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Genere un valor para este parámetro en su cliente. Asegúrese de que el valor sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII. Nota Si no especifica este parámetro, el sistema utiliza automáticamente el RequestId de la solicitud como ClientToken. El RequestId puede ser diferente para cada solicitud.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Especifica si se debe realizar una ejecución de prueba. Valores válidos: true: realiza una ejecución de prueba. El sistema verifica los parámetros requeridos, el formato de la solicitud y los límites del servicio. Si la solicitud no supera la ejecución de prueba, se devuelve un mensaje de error. Si la solicitud supera la ejecución de prueba, se devuelve un código de estado HTTP 2xx. false (predeterminado): envía la solicitud. Si la solicitud supera la verificación, se devuelve un código de estado HTTP 2xx y se realiza la operación.	true
EndpointGroupConfigurations	array<object>	Sí	Las configuraciones del grupo de endpoints.
	array<object>	No	Las configuraciones del grupo de endpoints.
EndpointGroupName	string	No	El nombre del grupo de endpoints. El nombre debe tener de 1 a 128 caracteres de longitud, comenzar con una letra o un carácter chino, y puede contener letras, dígitos, puntos (.), guiones bajos (_) y guiones (-).	group1
EndpointGroupDescription	string	No	La descripción del grupo de endpoints. La descripción puede tener hasta 200 caracteres de longitud y no puede comenzar con http:// o https://.	group1
TrafficPercentage	integer	No	La proporción de distribución de tráfico. Si un listener está asociado con múltiples grupos de endpoints, puede especificar este parámetro para distribuir el tráfico a los grupos de endpoints. Valores válidos: 1 a 100.	20
HealthCheckEnabled	boolean	No	Especifica si se debe habilitar la función de comprobación de estado. true: habilita la función de comprobación de estado. false (predeterminado): deshabilita la función de comprobación de estado.	true
HealthCheckIntervalSeconds	integer	No	El intervalo entre dos comprobaciones de estado consecutivas. Unidad: segundos. Valores válidos: 1 a 50.	3
HealthCheckPath	string	No	La ruta de la comprobación de estado.	/healthcheck
HealthCheckPort	integer	No	El puerto que se utiliza para las comprobaciones de estado. Valores válidos: 1 a 65535.	20
HealthCheckProtocol	string	No	El protocolo que se utiliza para las comprobaciones de estado. tcp o TCP: TCP http o HTTP: HTTP https o HTTPS: HTTPS	tcp
ThresholdCount	integer	No	El número de comprobaciones de estado consecutivas que un endpoint debe superar para considerarse saludable, o fallar para considerarse no saludable. Valores válidos: 2 a 10.	3
EndpointConfigurations	array<object>	No	Las configuraciones del endpoint.
	object	Sí	Las configuraciones del endpoint.
Type	string	Sí	El tipo de endpoint. Domain: un nombre de dominio personalizado. Ip: una dirección IP personalizada. IpTarget: una dirección IP privada personalizada. PublicIp: una dirección IP pública de Alibaba Cloud. ECS: una instancia de Elastic Compute Service (ECS) de Alibaba Cloud. SLB: una instancia de Server Load Balancer (SLB) de Alibaba Cloud. ALB: una instancia de Application Load Balancer (ALB) de Alibaba Cloud. OSS: un bucket de Object Storage Service (OSS) de Alibaba Cloud. ENI: una Elastic Network Interface (ENI) de Alibaba Cloud. NLB: una instancia de Network Load Balancer (NLB) de Alibaba Cloud. Nota Si establece el tipo de endpoint en ECS, ENI, SLB, NLB o IpTarget, y el rol vinculado al servicio no existe, el sistema crea automáticamente un rol vinculado al servicio llamado AliyunServiceRoleForGaVpcEndpoint. Si establece el tipo de endpoint en ALB, y el rol vinculado al servicio no existe, el sistema crea automáticamente un rol vinculado al servicio llamado AliyunServiceRoleForGaAlb. Si establece el tipo de endpoint en OSS, y el rol vinculado al servicio no existe, el sistema crea automáticamente un rol vinculado al servicio llamado AliyunServiceRoleForGaOss. Nota Para obtener más información, consulte .	Ip
Weight	integer	Sí	El peso del endpoint. Valores válidos: 0 a 255. Nota Si establece el peso de un endpoint en 0, GA deja de distribuir tráfico al endpoint. Maneje esto con precaución.	20
Endpoint	string	Sí	La dirección IP, el nombre de dominio o el ID de instancia del endpoint, según el valor de Type.	47.0.XX.XX
SubAddress	string	No	La dirección IP privada de la ENI. Nota Este parámetro está disponible solo cuando el tipo de endpoint es ENI. Puede especificar este parámetro. Si no especifica este parámetro, se utiliza la dirección IP privada principal de la ENI.	172.168.XX.XX
EnableClientIPPreservation	boolean	No	Especifica si se deben conservar las direcciones IP del cliente. Valores válidos: true: conserva las direcciones IP del cliente. false (predeterminado): no conserva las direcciones IP del cliente. Nota De forma predeterminada, la conservación de la dirección IP del cliente está deshabilitada para los grupos de endpoints de listeners TCP y UDP. Puede habilitarla según sus necesidades comerciales. La conservación de la dirección IP del cliente está habilitada de forma predeterminada para los grupos de endpoints de listeners HTTP y HTTPS. Las direcciones IP del cliente se recuperan del campo de encabezado X-Forwarded-For. No puede deshabilitar esta función. EnableClientIPPreservation y EnableProxyProtocol no pueden establecerse en true al mismo tiempo. Para obtener más información, consulte .
EnableProxyProtocol	boolean	No	Especifica si se debe usar Proxy Protocol para conservar las direcciones IP del cliente. Valores válidos: true: usa Proxy Protocol. false (predeterminado): no usa Proxy Protocol. Nota Este parámetro está disponible solo para grupos de endpoints de listeners TCP. EnableClientIPPreservation y EnableProxyProtocol no pueden establecerse en true al mismo tiempo. Para obtener más información, consulte .
VpcId	string	No	El ID de la nube privada virtual (VPC). Puede especificar como máximo un ID de VPC para un grupo de endpoints asociado con un listener que utiliza enrutamiento inteligente. Nota Este parámetro es obligatorio y surte efecto solo cuando el tipo de endpoint es IpTarget.	vpc-uf66oesmrqge1t2gs****
VSwitchIds	array	No	La lista de vSwitches en la VPC.
	string	No	El ID del vSwitch. Puede especificar como máximo dos ID de vSwitch para un grupo de endpoints asociado con un listener que utiliza enrutamiento inteligente. Nota Este parámetro es obligatorio y surte efecto solo cuando el tipo de endpoint es IpTarget. El vSwitch debe pertenecer a la VPC especificada por el parámetro VpcId.	vsw-uf6r0due94mypz1i9****
Provider	string	No		BAILIAN
ApiKeys	array	No
	string	No		sk-*******
EndpointRequestProtocol	string	No	El protocolo del servicio backend. Valores válidos: HTTP: HTTP HTTPS: HTTPS Nota Solo puede establecer este parámetro cuando crea un grupo de endpoints para un listener HTTP o HTTPS. Para un listener HTTP, el protocolo del servicio backend debe ser HTTP.	HTTP
EndpointProtocolVersion	string	No	La versión del protocolo del servicio backend para endpoints en un listener que utiliza enrutamiento inteligente. Valores válidos: HTTP1.1 (predeterminado): HTTP/1.1 HTTP2: HTTP/2 Nota Este parámetro está disponible solo cuando establece EndpointRequestProtocol en HTTPS.	HTTP1.1
PortOverrides	array<object>	No	La asignación de puertos.
	object	No	La asignación de puertos.
ListenerPort	integer	No	El puerto del listener. Valores válidos: 1 a 65499. Nota Para listeners TCP, los grupos de endpoints virtuales no admiten asignación de puertos. Si ya existe un grupo de endpoints virtual bajo el listener, no puede configurar la asignación de puertos para el grupo de endpoints predeterminado. Si la asignación de puertos ya está configurada para el grupo de endpoints predeterminado, no puede agregar un grupo de endpoints virtual. Después de configurar la asignación de puertos, se aplican los siguientes límites a las modificaciones posteriores del listener: no puede cambiar el protocolo del listener, excepto para cambiarlo entre HTTP y HTTPS. Puerto del listener: el rango de puertos del listener modificado debe incluir todos los puertos del listener que están asignados actualmente. Por ejemplo, si el rango de puertos del listener es 80-82 y los puertos están asignados a los puertos de endpoint 100-102, no puede cambiar el rango de puertos del listener a 80-81.	443
EndpointPort	integer	No	El puerto del endpoint. Valores válidos: 1 a 65499.	80
EnableClientIPPreservationToa	boolean	No	Especifica si se debe usar el módulo TCP Option Address (TOA) para conservar las direcciones IP del cliente. Valores válidos: true: sí. false: no.	false
EnableClientIPPreservationProxyProtocol	boolean	No	Especifica si se debe usar Proxy Protocol para conservar las direcciones IP del cliente. Valores válidos: true: sí. false: no.	false
EndpointGroupId	string	Sí	El ID del grupo de endpoints.	ep-bp1d2utp8qqe2a44t****
HealthCheckHost	string	No
EndpointIpVersion	string	No
ListenerId	string	Sí	El ID del listener.	lsr-bp1bpn0kn908w4nbw****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
RequestId	string	El ID de la solicitud.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	Los ID de los grupos de endpoints.
	string	El ID del grupo de endpoints.	epg-bp1dmlohjjz4kqaun****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "EndpointGroupIds": [
    "epg-bp1dmlohjjz4kqaun****"
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.	The current account does not have the permissions to enable health checks.
400	NotExist.EndPointGroup	The endpoint group does not exist.	The endpoint group does not exist.
400	StateError.EndPointGroup	The specified state of endpoint group is invalid.	The endpoint group is in an invalid state.
400	NotExist.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The listener is unstable.
400	NotExist.Accelerator	The accelerated instance does not exist.	The GA instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The status of the GA instance is invalid.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	The user does not have permissions to create service linked roles. Contact the Alibaba Cloud account owner or the permission administrator to grant the current user AliyunGlobalAccelerationFullAccess or create custom permission policies for service linked role. The following content describes the detailed information about custom permission policies: ServiceName: vpcendpoint.ga.aliyuncs.com. Service linked role name: AliyunServiceRoleForGaVpc. Endpoint Permission: ram:CreateServiceLinkedRole.
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.	The number of port override exceeds the limit.
400	NotExist.ListenerPort	listener port %s is not exist

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.