Creates an endpoint group.
Operation description
-
When you call this operation to create a virtual endpoint group for a Layer 4 listener, make sure that a default endpoint group is created.
-
CreateEndpointGroup is an asynchronous operation. After you send a request, the system returns the ID of an endpoint group, but the endpoint group is still being created in the system background. You can call the DescribeEndpointGroup operation to query the state of the endpoint group.
- If the endpoint group is in the init state, it indicates that the endpoint group is being created. In this case, you can perform only query operations.
- If the endpoint group is in the active state, it indicates that the endpoint group is created.
-
The CreateEndpointGroup operation cannot be repeatedly called for the same Global Accelerator (GA) instance within a specific period of time.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ga:CreateEndpointGroup | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region where the GA instance is deployed. 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 token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 123e4567-e89b-12d3-a456-426655440000 |
AcceleratorId | string | Yes | The ID of the GA instance. | ga-bp1odcab8tmno0hdq**** |
Name | 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 (-). The name must start with a letter. | group1 |
Description | string | No | The description of the endpoint group. The description can be up to 200 characters in length and cannot start with | EndpointGroup |
EndpointGroupRegion | string | Yes | The ID of the region in which to create the endpoint group. | cn-hangzhou |
ListenerId | string | Yes | The ID of the listener. | lsr-bp1bpn0kn908w4nbw**** |
TrafficPercentage | integer | No | The traffic ratio for the endpoint group when the specified listener is associated with multiple endpoint groups. Valid values: 1 to 100. | 20 |
HealthCheckIntervalSeconds | integer | No | The interval at which health checks are performed. Unit: seconds. | 3 |
HealthCheckPath | string | No | The path to which to send health check requests. | /healthcheck |
HealthCheckPort | integer | No | The port that is used for health checks. | 20 |
HealthCheckProtocol | string | No | The protocol over which to send health check requests. Valid values:
| tcp |
ThresholdCount | integer | No | The number of consecutive health check failures that must occur before a healthy endpoint group is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint group is considered healthy. Valid values: 2 to 10. Default value: 3. | 3 |
EndpointConfigurations | array<object> | No | The configurations of endpoints in the endpoint group. | |
object | No | The configurations of the endpoint. | ||
Type | string | Yes | The type of the endpoint. Valid values:
Note
For more information, see Service-linked roles. | Ip |
EnableClientIPPreservation | boolean | No | Specifies whether to preserve client IP addresses by using the TCP Option Address (TOA) module. Valid values:
| false |
Weight | integer | Yes | The weight of the endpoint. Valid values: 0 to 255. Note
If you set the weight of an endpoint to 0, GA stops distributing traffic to the endpoint. Proceed with caution.
| 20 |
EnableProxyProtocol | boolean | No | Specifies whether to use the proxy protocol to preserve client IP addresses. Valid values:
| false |
Endpoint | string | Yes | Enter the IP address, domain name, or instance ID based on the value of the Type parameter. | 120.1.XX.XX |
SubAddress | string | No | The private IP address of the ENI. Note
This parameter is available only when you set the endpoint type to ENI. If you leave this parameter empty, the primary private IP address of the ENI is used.
| 172.168.XX.XX |
EndpointRequestProtocol | string | No | The protocol that is used by the backend service. Default value: HTTP. Valid values:
Note
| HTTP |
EndpointProtocolVersion | string | No | The version of the protocol that is used by the backend service. Valid values:
Note
This parameter is required only when you set the EndpointRequestProtocol parameter to HTTPS.
| |
EndpointGroupType | string | No | The type of the endpoint group. Valid values:
Note
When you call this operation to create a virtual endpoint group for a Layer 4 listener, make sure that a default endpoint group is created.
| default |
PortOverrides | array<object> | No | The mappings between ports. | |
object | No | The mappings between ports. | ||
ListenerPort | integer | No | The listener port that is mapped to the endpoint port. Note
| 443 |
EndpointPort | integer | No | The endpoint port that is mapped to the listener port. | 80 |
HealthCheckEnabled | boolean | No | Specifies whether to enable the health check feature. Valid values:
| true |
Tag | array<object> | No | Tags of GA instances. | |
object | No | The tag of the GA instance. | ||
Key | string | No | The tag key of the GA instance. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain You can specify up to 20 tag keys. | test-key |
Value | string | No | The tag value of the GA instance. The tag value cannot be an empty string. The tag value can be up to 128 characters in length and cannot contain You can specify up to 20 tag values. | test-value |
Response parameters
Examples
Sample success responses
JSON
format
{
"EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
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 | NotExist.ListenerPort | The listening port %s does not exist. | The listening port does not exist. |
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.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 | Exist.EndpointGroup | The endpoint group already exists. | The endpoint group already exists. |
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 | - |
500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | An error occurred while the request was being processed. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-07-20 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-11-22 | The Error code has changed | View Change Details |
2023-09-14 | The Error code has changed | View Change Details |
2023-06-20 | The Error code has changed | View Change Details |
2023-04-20 | The Error code has changed | View Change Details |
2023-03-31 | The Error code has changed. The request parameters of the API has changed | View Change Details |