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

Crea grupos de endpoints en lotes.

Descripción de la operación

Crea grupos de endpoints en lotes. No se pueden crear grupos de endpoints predeterminados y virtuales en una sola llamada.
Esta API no admite la creación de grupos de endpoints virtuales para listeners de capa 4. Para crear un grupo de endpoints virtual para un listener de capa 4, llame a CreateEndpointGroup.
CreateEndpointGroups es una API asíncrona. Devuelve un ID de solicitud y crea los grupos de endpoints en segundo plano. Puede llamar a DescribeEndpointGroup o ListEndpointGroups para consultar el estado de un grupo de endpoints:
- Si un grupo de endpoints está en estado init, se encuentra en proceso de inicialización. Solo puede consultar el grupo de endpoints en este estado.
- La creación por lotes se completa cuando todos los grupos de endpoints están en estado active.
No puede realizar llamadas simultáneas a CreateEndpointGroups para la misma instancia de Global Accelerator.

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

create

*EndpointGroup

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

*Accelerator

acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

ga:AcceleratorMainland

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región donde se despliega el acelerador. Establezca el valor en cn-hangzhou.	cn-hangzhou
ClientToken	string	No	El token de cliente utilizado para garantizar la idempotencia de la solicitud. Puede generar el token en su cliente. Asegúrese de que sea único en diferentes solicitudes. El valor de `ClientToken` 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 es único para cada solicitud de API.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	No	Especifica si se debe realizar una ejecución de prueba (dry run). Valores válidos: true: realiza una ejecución de prueba pero no crea el recurso. El sistema verifica los parámetros obligatorios, el formato de la solicitud y los límites del servicio. Si la solicitud no supera la ejecución de prueba, el sistema devuelve un mensaje de error. Si la solicitud supera la ejecución de prueba, el sistema devuelve un código de estado HTTP 2xx. false (valor predeterminado): envía una solicitud normal y crea el recurso si la solicitud se aprueba.	true
AcceleratorId	string	Sí	El ID del acelerador.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Sí	El ID del listener. Nota Si el protocolo del listener es HTTP o HTTPS, solo puede crear un grupo de endpoints en cada llamada a CreateEndpointGroups.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	Sí	Las configuraciones de los grupos de endpoints. Puede configurar hasta 10 grupos de endpoints.
	array<object>	No	La configuración de un grupo de endpoints.
EndpointGroupName	string	No	El nombre del grupo de endpoints. El nombre debe tener entre 1 y 128 caracteres, comenzar con una letra o un carácter chino, y contener 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://`.	EndpointGroup
EndpointGroupRegion	string	Sí	El ID de la región donde se despliega el grupo de endpoints. Puede ingresar hasta 10 ID de región de grupos de endpoints.	cn-hongkong
TrafficPercentage	integer	No	El porcentaje de distribución de tráfico para el grupo de endpoints. Si un listener de enrutamiento inteligente está asociado con múltiples grupos de endpoints, este parámetro especifica el porcentaje de tráfico que se enruta a este grupo de endpoints. Valores válidos: 1 a 100. Valor predeterminado: 100. Puede ingresar valores de marcado de tráfico para hasta 10 grupos de endpoints.	100
HealthCheckEnabled	boolean	No	Especifica si se deben habilitar las verificaciones de estado para el grupo de endpoints. Valores válidos: true: habilita las verificaciones de estado. false (valor predeterminado): deshabilita las verificaciones de estado. Puede habilitar verificaciones de estado para hasta 10 grupos de endpoints.	false
HealthCheckIntervalSeconds	integer	No	El intervalo entre verificaciones de estado, en segundos. Puede ingresar hasta 10 intervalos de verificación de estado.	5
HealthCheckPath	string	No	La ruta utilizada para las verificaciones de estado. Puede ingresar hasta 10 rutas de verificación de estado.	/healthcheck
HealthCheckPort	integer	No	El puerto utilizado para las verificaciones de estado. Valores válidos: 1 a 65535. Puede ingresar hasta 10 puertos para verificaciones de estado.	443
HealthCheckProtocol	string	No	El protocolo utilizado para las verificaciones de estado. Valores válidos: tcp o TCP: protocolo TCP. http o HTTP: protocolo HTTP. https o HTTPS: protocolo HTTPS. Puede ingresar hasta 10 protocolos de verificación de estado.	HTTPS
ThresholdCount	integer	No	El número de verificaciones de estado consecutivas que deben ser exitosas para que un endpoint se considere saludable, o fallidas para que se considere no saludable. Valores válidos: 2 a 10. Valor predeterminado: 3. Puede ingresar hasta 10 valores para el número de verificaciones de estado consecutivas requeridas para un cambio de estado de salud.	3
EndpointConfigurations	array<object>	No	Las configuraciones de los endpoints en el grupo de endpoints.
	object	No	La configuración de un endpoint.
Type	string	No	El tipo de endpoint en un listener de enrutamiento inteligente. Valores válidos: 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 ECS. SLB: una instancia de SLB. ALB: una instancia de ALB. OSS: un bucket de OSS. ENI: una interfaz de red elástica. NLB: una instancia de NLB. En un grupo de endpoints de un listener de enrutamiento inteligente, puede especificar hasta 100 endpoints. Nota Si el tipo de enrutamiento del listener es Standard (enrutamiento inteligente), debe configurar el grupo de endpoints y la información del endpoint para el listener. Este parámetro es obligatorio. Si establece Type en ECS, ENI, SLB o IpTarget y no existe un rol vinculado al servicio, el sistema crea automáticamente un rol vinculado al servicio llamado AliyunServiceRoleForGaVpcEndpoint. Si establece Type en ALB y no existe un rol vinculado al servicio, el sistema crea automáticamente un rol vinculado al servicio llamado AliyunServiceRoleForGaAlb. Si establece Type en OSS y no existe un rol vinculado al servicio, el sistema crea automáticamente un rol vinculado al servicio llamado AliyunServiceRoleForGaOss. Si establece Type en NLB y no existe un rol vinculado al servicio, el sistema crea automáticamente un rol vinculado al servicio llamado AliyunServiceRoleForGaNlb. Nota Para obtener más información, consulte roles vinculados al servicio.	Domain
Weight	integer	No	El peso del endpoint. Valores válidos: 0 a 255. Nota Si establece el peso de un endpoint en 0, Global Accelerator deja de distribuir tráfico al endpoint. Proceda con precaución.	255
Endpoint	string	No	La dirección IP o el nombre de dominio del endpoint. En un grupo de endpoints de un listener de enrutamiento inteligente, puede ingresar un máximo de 100 direcciones IP o nombres de dominio de endpoints.	1.1.1.1
SubAddress	string	No	La dirección IP privada de la interfaz de red elástica (ENI). Nota Este parámetro solo está disponible cuando el tipo de endpoint es ENI. Si no especifica este parámetro, el sistema 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 (valor predeterminado): no conserva las direcciones IP del cliente. Nota Para grupos de endpoints de listeners UDP y TCP, la función de conservación de IP del cliente está deshabilitada de forma predeterminada. Puede habilitar esta función según sus requisitos comerciales. Para grupos de endpoints de listeners HTTP y HTTPS, la función de conservación de IP del cliente está habilitada de forma predeterminada. Las direcciones IP del cliente se conservan en el 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 conservar direcciones IP del cliente.	false
EnableProxyProtocol	boolean	No	Especifica si se debe usar el protocolo Proxy para conservar las direcciones IP del cliente. Valores válidos: true: usa el protocolo Proxy para conservar las direcciones IP del cliente. false (valor predeterminado): no usa el protocolo Proxy para conservar las direcciones IP del cliente. Nota Este parámetro solo está disponible para grupos de endpoints asociados con listeners TCP. `EnableClientIPPreservation` y `EnableProxyProtocol` no pueden establecerse en `true` al mismo tiempo. Para obtener más información, consulte conservar direcciones IP del cliente.	false
VpcId	string	No	El ID de la VPC. En un grupo de endpoints de un listener de enrutamiento inteligente, solo puede especificar un ID de VPC. Nota Este parámetro es obligatorio solo cuando establece Type en IpTarget.	vpc-2zekzii824szm3hps****
VSwitchIds	array	No	Una lista de ID de VSwitch.
	string	No	El ID del VSwitch. En un grupo de endpoints de un listener de enrutamiento inteligente, puede especificar hasta dos ID de VSwitch. Nota Este parámetro es obligatorio y aplica solo cuando el tipo de endpoint es IpTarget. El VSwitch debe estar en la VPC especificada por el parámetro VpcId.	vsw-bp1b2qx7y2qqnbkan****
Provider	string	No		BAILIAN
ApiKeys	array	No
	string	No		sk-******
EndpointRequestProtocol	string	No	El protocolo del servicio backend. Valores válidos: HTTP HTTPS Nota Solo puede establecer este parámetro cuando crea un grupo de endpoints para un listener HTTP o HTTPS. Para un listener HTTP, solo puede establecer este parámetro en HTTP.	HTTPS
EndpointProtocolVersion	string	No	La versión del protocolo del servicio backend. Valores válidos: HTTP1.1 (valor predeterminado): HTTP 1.1. HTTP2: HTTP 2. Nota Solo puede establecer este parámetro cuando `EndpointRequestProtocol` se establece en HTTPS.	HTTP1.1
EndpointGroupType	string	No	El tipo de grupo de endpoints en un listener de enrutamiento inteligente. Valores válidos: default (valor predeterminado): un grupo de endpoints predeterminado. virtual: un grupo de endpoints virtual. Puede ingresar hasta 10 tipos de grupos de endpoints.	default
PortOverrides	array<object>	No	La configuración de anulación de puertos.
	object	No	Una configuración de anulación de puerto.
ListenerPort	integer	No	El puerto del listener. Valores válidos: 1 a 65499. Nota Para listeners TCP, no puede configurar anulaciones de puerto para un grupo de endpoints virtual. Si ya existe un grupo de endpoints virtual para el listener, no puede configurar anulaciones de puerto para el grupo de endpoints predeterminado. Si hay anulaciones de puerto configuradas para el grupo de endpoints predeterminado, no puede agregar un grupo de endpoints virtual. Después de configurar una anulación de puerto, no puede cambiar el protocolo del listener, excepto para alternar entre HTTP y HTTPS. Cuando modifica el rango de puertos del listener, el nuevo rango debe incluir todos los puertos del listener que se utilizan en las anulaciones de puerto. Por ejemplo, si el rango de puertos del listener es 80-82 y se configura una anulación de puerto para asignar puertos de listener a puertos de endpoint 100-102, no puede cambiar el rango de puertos del listener a 80-81.	80
EndpointPort	integer	No	El puerto del endpoint utilizado para la anulación de puerto.	443
Tag	array<object>	No	Las etiquetas para agregar al grupo de endpoints. Puede especificar hasta 20 etiquetas.
	object	No	Las etiquetas del grupo de endpoints.
Key	string	No	La clave de la etiqueta. La clave de la etiqueta no puede ser una cadena vacía. La clave de la etiqueta puede tener hasta 64 caracteres de longitud y no puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`. Puede ingresar hasta 20 claves de etiqueta.	tag-key
Value	string	No	El valor de la etiqueta. El valor de la etiqueta puede ser una cadena vacía. El valor de la etiqueta puede tener hasta 128 caracteres de longitud y no puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`. Puede ingresar hasta 20 valores de etiqueta.	tag-value
SystemTag	array<object>	No	Este parámetro está reservado.
	object	No	Este parámetro está reservado.
Key	string	No	Este parámetro está reservado.	-
Value	string	No	Este parámetro está reservado.	-
Scope	string	No	Este parámetro está reservado.	-
HealthCheckHost	string	No	El nombre de dominio al que se envían las solicitudes de verificación de estado.	www.taobao.com
EndpointIpVersion	string	No	La versión de IP del servicio backend. Valores válidos: IPv4 (valor predeterminado): Global Accelerator utiliza solo direcciones IPv4 para comunicarse con el servicio backend. IPv6: Global Accelerator utiliza solo direcciones IPv6 para comunicarse con el servicio backend. ProtocolAffinity: Global Accelerator se comunica con el servicio backend utilizando la misma versión de IP que la solicitud del cliente.	IPv4

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
RequestId	string	El ID de la solicitud.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	Los ID de los grupos de endpoints.
	string	El ID de un 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	Domain.NotFit	The domain is not fit the rule	The domain name does not have an ICP number.
400	Resource.QuotaFull	The resource quota is exceeded.	The number of resources has reached the upper limit.
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	NotSupportHealthCheck.Accelerator	Currently Accelerator does not support health check.	The current GA instance does not support health checks.
400	EndpointGroupExclusive.Listener	All endpoint group must under the same listener.	All the endpoint groups must be associated with the same listener.
400	RegionConflict.EndpointGroup	Endpoint group under the same listener must have different region.	The endpoint groups that are associated with the same listener must be deployed in different regions.
400	ListenerProtocolIllegal.EndpointGroup	Listener protocol is illegal, the https/http listener instance is only allowed to have one default endpoint group.	You can configure only one default endpoint group for an HTTPS or HTTP listener.
400	QuotaExceeded.EndpointGroup	The number of endpoint group exceeds the limit.	The number of endpoint groups has reached the upper limit.
400	ParamExclusive.EndpointGroupType	All endpoint group type group must be consistent.
400	HealthCheckPath.Illegal	Health check path illegal.	The health check path is invalid.
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	NotExist.BusinessRegion	The business region does not exist.	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
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
400	MixedVpc.EndPoint	VPC Endpoint cannot be mixed with other types of Endpoints.	You cannot use private endpoints with other types of endpoints.
400	IllegalPublicIp.EndPoint	The public IP address configured for the endpoint is invalid. Only an Alibaba Cloud public IP address in the region of the endpoint can be configured.	The public IP address configured for the endpoint is invalid. Only an Alibaba Cloud public IP address in the region of the endpoint can be configured.

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.