CreateEndpointGroups-阿里云帮助中心

Creates an endpoint group list.

Operation description

You can invoke this operation to create an endpoint group in batches. However, you cannot create default endpoint groups and virtual endpoint groups at the same time.
This operation does not support creating an endpoint group that is virtual for Layer 4 protocol listeners. To create an endpoint group that is virtual for a Layer 4 protocol listener, use CreateEndpointGroup.
The CreateEndpointGroups operation is asynchronous. The system returns a request ID, but the endpoint groups are not immediately created. The creation node in the background system is still in progress. You can invoke DescribeEndpointGroup or ListEndpointGroups to query the status of the endpoint groups:
- If an endpoint group is in the init state, the endpoint groups are being created in batches. In this state, you can only perform query operations.
- If all endpoint groups are in the active state, the endpoint groups are created.
The CreateEndpointGroups operation does not support concurrent operations to create an endpoint group within the same Alibaba Cloud Global Accelerator (GA) instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: prechecks the request without creating the resource. The system checks whether the required parameters are specified, the request format, and the service limits. If the request fails the precheck, the corresponding error is returned. If the request passes the precheck, an HTTP 2xx status code is returned. false (default): sends the request. If the request passes the precheck, an HTTP 2xx status code is returned and the operation is performed.	true
AcceleratorId	string	Yes	The Alibaba Cloud Global Accelerator (GA) instance ID.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Yes	The listener ID. Note If the listener protocol is HTTP or HTTPS, you can create only one endpoint group each time you call the CreateEndpointGroups operation.	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	array<object>	Yes	The endpoint group configurations. You can specify up to 10 endpoint groups.
	array<object>	No	The endpoint group configurations. You can specify up to 10 endpoint groups.
EndpointGroupName	string	No	The name of the endpoint group. The name must be 1 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter or Chinese character.	group1
EndpointGroupDescription	string	No	The description of the endpoint group. The description can be up to 200 characters in length, and cannot start with http:// or https://.	EndpointGroup
EndpointGroupRegion	string	Yes	The region ID of the endpoint group. You can specify up to 10 region IDs.	cn-hongkong
TrafficPercentage	integer	No	The traffic distribution ratio. When a listener uses intelligent routing and has multiple endpoint groups, this parameter specifies the proportion of traffic distributed to each endpoint group. Valid values: 1 to 100. Default value: 100. You can specify the traffic distribution ratio for up to 10 endpoint groups.	100
HealthCheckEnabled	boolean	No	Specifies whether to enable health checks for the endpoint group of a listener that uses intelligent routing. Valid values: true: enables health checks. false (default): disables health checks. You can enable health checks for up to 10 endpoint groups.	false
HealthCheckIntervalSeconds	integer	No	The interval between two consecutive health checks. Unit: seconds. You can specify the health check interval for up to 10 endpoint groups.	5
HealthCheckPath	string	No	The health check path. You can specify the health check path for up to 10 endpoint groups.	/healthcheck
HealthCheckPort	integer	No	The health check port. Valid values: 1 to 65535. You can specify the health check port for up to 10 endpoint groups.	443
HealthCheckProtocol	string	No	The health check protocol. Valid values: tcp or TCP: TCP http or HTTP: HTTP https or HTTPS: HTTPS You can specify the health check protocol for up to 10 endpoint groups.	HTTPS
ThresholdCount	integer	No	The number of consecutive health checks that must succeed or fail before the health check status changes. Specifically, this is the number of consecutive failed health checks required to change the status from healthy to unhealthy, or the number of consecutive successful health checks required to change the status from unhealthy to healthy. Valid values: 2 to 10. Default value: 3. You can specify the threshold for up to 10 endpoint groups.	3
EndpointConfigurations	array<object>	No	The endpoint configurations for a listener that uses intelligent routing.
	object	No	The endpoint configurations for a listener that uses intelligent routing.
Type	string	No	The endpoint type for a listener that uses intelligent routing. Valid values: Domain: custom domain name Ip: custom IP address IpTarget: custom private IP PublicIp: Alibaba Cloud public IP address ECS: ECS instance SLB: Server Load Balancer (SLB) instance ALB: Application Load Balancer (ALB) instance OSS: Object Storage Service (OSS) instance ENI: Alibaba Cloud elastic network interface controller (NIC) NLB: Network Load Balancer (NLB) instance You can specify up to 100 endpoints in an endpoint group of a listener that uses intelligent routing. Note When Type (listener routing type) is set to Standard (intelligent routing), you can configure the endpoint group and endpoint information for the listener, and this parameter is required. If the endpoint type is set to ECS, ENI, SLB, ALB, NLB, or IpTarget, and the service associate role does not exist, the system automatically creates a service associate role named AliyunServiceRoleForGaVpcEndpoint. If the endpoint type is set to ALB, and the service associate role does not exist, the system automatically creates a service associate role named AliyunServiceRoleForGaAlb. If the endpoint type is set to OSS, and the service associate role does not exist, the system automatically creates a service associate role named AliyunServiceRoleForGaOss. If the endpoint type is set to NLB, and the service associate role does not exist, the system automatically creates a service associate role named AliyunServiceRoleForGaNlb. Note For more information, see Service associate roles.	Domain
Weight	integer	No	The weight of the endpoint. Valid values: 0 to 255. Note If the weight of an endpoint is set to 0, Global Accelerator stops distributing traffic to the endpoint. Proceed with caution.	255
Endpoint	string	No	The IP address or domain name of the endpoint for a listener that uses intelligent routing. You can specify up to 100 IP addresses or domain names in an endpoint group of a listener that uses intelligent routing.	1.1.1.1
SubAddress	string	No	The private IP of the elastic network interface controller (NIC). Note If the endpoint type is ENI, you can configure this parameter. If you do not configure this parameter, the primary private IP of the elastic network interface controller (NIC) is used by default.	172.168.XX.XX
EnableClientIPPreservation	boolean	No	Specifies whether to enable client IP address preservation by using the automatic retrieval method. Valid values: true: enables client IP address preservation. false (default): disables client IP address preservation. Note By default, client IP address preservation is disabled for endpoint groups of UDP or TCP listeners. You can configure this parameter based on your business requirements. By default, client IP address preservation is enabled for endpoint groups of HTTP or HTTPS listeners. The client IP addresses are retrieved by using the X-Forwarded-For header field. You cannot disable this feature. EnableClientIPPreservation and EnableProxyProtocol cannot be set to true at the same time. For more information, see Preserve client IP addresses.	false
EnableProxyProtocol	boolean	No	Specifies whether to enable client IP address preservation by using the Proxy Protocol. Valid values: true: enables client IP address preservation. false (default): disables client IP address preservation. Note This parameter is supported only for endpoint groups of TCP listeners. EnableClientIPPreservation and EnableProxyProtocol cannot be set to true at the same time. For more information, see Preserve client IP addresses.	false
VpcId	string	No	The VPC ID. You can specify only one VPC ID in an endpoint group of a listener that uses intelligent routing. Note This parameter is valid and required only when the endpoint type is IpTarget.	vpc-2zekzii824szm3hps****
VSwitchIds	array	No	The vSwitches in the VPC.
	string	No	The vSwitch ID. You can specify up to two vSwitch IDs in an endpoint group of a listener that uses intelligent routing. Note This parameter is valid and required only when the endpoint type is IpTarget. The vSwitch must belong to the VPC specified by the VpcId parameter.	vsw-bp1b2qx7y2qqnbkan****
Provider	string	No	The provider configuration.	BAILIAN
ApiKeys	array	No	The API keys in the endpoint group configuration.
	string	No	The API keys in the endpoint group configuration.	sk-******
EndpointRequestProtocol	string	No	The backend service Terms of Service. Valid values: HTTP: HTTP HTTPS: HTTPS Note This parameter is supported only when you create an endpoint group for an HTTP or HTTPS listener instance. For an HTTP listener instance, the backend service Terms of Service must be HTTP.	HTTPS
EndpointProtocolVersion	string	No	The backend service Terms of Service version for the endpoint of a listener that uses intelligent routing. Valid values: HTTP1.1 (default): HTTP/1.1 HTTP2: HTTP/2 Note You can specify the backend service Terms of Service version only when the EndpointRequestProtocol (backend service Terms of Service) parameter is set to HTTPS.	HTTP1.1
EndpointGroupType	string	No	The endpoint group type for a listener that uses intelligent routing. Valid values: default (default): default endpoint group virtual: virtual endpoint group You can specify up to 10 endpoint group types.	default
PortOverrides	array<object>	No	The port mappings.
	object	No	The port mappings.
ListenerPort	integer	No	The listener port. Valid values: 1 to 65499. Note For TCP listeners: Virtual endpoint groups do not support port mappings. If a virtual endpoint group already exists under the listener, the default endpoint group cannot be configured with port mappings. If the default endpoint group is already configured with port mappings, you cannot add a virtual endpoint group. After port mappings are configured, the following limits apply to subsequent listener modifications: You cannot modify the listener protocol, except for switching between HTTP and HTTPS. Listener port: The modified listener port range must include all listener ports currently configured in the port mappings. For example, if the listener port range is 80-82 and port mappings are configured to endpoint ports 100-102, you cannot change the listener port range to 80-81 later.	80
EndpointPort	integer	No	The endpoint port for port mapping.	443
Tag	array<object>	No	The tags of the endpoint group.
	object	No	The tags of the endpoint group.
Key	string	No	The tag key of the endpoint group. The tag key cannot be an empty string. The tag key can be up to 64 characters in length, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys.	tag-key
Value	string	No	The tag value of the endpoint group. The tag value can be an empty string. The tag value can be up to 128 characters in length, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag values.	tag-value
SystemTag	array<object>	No	This parameter is not used. You do not need to configure it.
	object	No	This parameter is not used. You do not need to configure it.
Key	string	No	This parameter is not used. You do not need to configure it.	-
Value	string	No	This parameter is not used. You do not need to configure it.	-
Scope	string	No	This parameter is not used. You do not need to configure it.	-
HealthCheckHost	string	No	The domain name for health checks.	www.taobao.com
EndpointIpVersion	string	No	The IP version of the backend service. Valid values: IPv4 (default): GA communicates with the endpoint service only over IPv4. IPv6: GA communicates with the endpoint service only over IPv6. ProtocolAffinity: GA communicates with the endpoint service over the same IP version as the client request.	IPv4
ProxyTunnel	object	No	The proxy tunnel configuration.
ConnectAuthPrefix	string	No	The proxy tunnel connection authentication prefix.	prefix-auth
ConnectAuthSuffix	string	No	The proxy tunnel connection authentication suffix.	suffix-auth
ConnectSessionHashHdr	string	No	The connection session hash header configuration.	X-Session-Hash
ConnectTunnelTimeout	integer	No	The proxy tunnel connection timeout period.	5000
TunnelServerPort	integer	No	The tunnel server port.	8443
TunnelServerType	string	No	The tunnel server type.	domain
TunnelServer	string	No	The tunnel server configuration.	tunnel.example.com
HealthCheckMethod	string	No	The health check method.	GET

Response elements

Element	Type	Description	Example
	object	The returned information.
RequestId	string	The request ID.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	The list of endpoint group IDs.
	string	The list of endpoint group IDs.	epg-bp1dmlohjjz4kqaun****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.