All Products
Search

This Product

    Global Accelerator:CreateEndpointGroups

    Document Center

    Global Accelerator:CreateEndpointGroups

    Last Updated:Apr 10, 2024

    Creates endpoint groups.

    Operation description

    • CreateEndpointGroups is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeEndpointGroup or ListEndpointGroups operation to query the status of the task:

      • If the endpoint groups are in the init state, the endpoint groups are being created. In this case, you can perform only query operations.
      • If all endpoint groups are in the active state, the endpoint groups are created.

    • The CreateEndpointGroups operation cannot be repeatedly called for the same Global Accelerator (GA) instance within a specific period of time.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    ga:CreateEndpointGroupsWrite
    • 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

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

    		cn-hangzhou
    ClientTokenstringNo

    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.
    		1F4B6A4A-C89E-489E-BAF1-52777EE148EF
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		true
    AcceleratorIdstringYes

    The ID of the GA instance.

    		ga-bp1odcab8tmno0hdq****
    ListenerIdstringYes

    The ID of the listener.

    Note If the listener protocol is HTTP or HTTPS, you can call the CreateEndpointGroups operation to create only one endpoint group.
    		lsr-bp1bpn0kn908w4nbw****
    EndpointGroupConfigurationsobject []Yes

    The configurations of the endpoint groups.

    EndpointGroupNamestringNo

    The name of the endpoint group.

    The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

    You can specify the names of up to 10 endpoint groups.

    		group1
    EndpointGroupDescriptionstringNo

    The description of the endpoint group.

    The description can be up to 256 characters in length and cannot contain http:// or https://.

    You can enter the descriptions of up to 10 endpoint groups.

    		group1
    EndpointGroupRegionstringYes

    The ID of the region where you want to create the endpoint group.

    You can enter the region IDs of up to 10 endpoint groups.

    		cn-hangzhou
    TrafficPercentagelongNo

    The traffic distribution ratio. If a listener is associated with multiple endpoint groups, you can specify this parameter to distribute traffic to the endpoint groups based on ratios.

    Valid values: 1 to 100. Default value: 100.

    You can specify traffic distribution ratios for up to 10 endpoint groups.

    		20
    HealthCheckEnabledbooleanNo

    Specifies whether to enable the health check feature. Valid values:

    • true
    • false (default)

    You can enable the health check feature for up to 10 endpoint groups.

    		false
    HealthCheckIntervalSecondslongNo

    The interval at which health checks are performed. Unit: seconds.

    You can specify up to 10 health check intervals.

    		3
    HealthCheckPathstringNo

    The path to which health check requests are sent.

    You can specify up to 10 health check paths.

    		/healthcheck
    HealthCheckPortlongNo

    The port that is used for health checks. Valid values: 1 to 65535.

    You can specify up to 10 ports for health checks.

    		20
    HealthCheckProtocolstringNo

    The protocol over which health check requests are sent. Valid values:

    • tcp
    • http
    • https

    You can specify up to 10 health check protocols.

    		tcp
    ThresholdCountlongNo

    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.

    You can specify the number of successful consecutive health checks or failed consecutive health checks for up to 10 endpoint groups.

    		3
    EndpointConfigurationsobject []No

    The configurations of the endpoints.

    TypestringNo

    The type of the endpoint. Valid values:

    • Domain: a custom domain name
    • Ip: a custom IP address
    • PublicIp: a public IP address provided by Alibaba Cloud
    • ECS: an Elastic Compute Service (ECS) instance
    • SLB: a Server Load Balancer (SLB) instance
    • ALB: an Application Load Balancer (ALB) instance
    • OSS: an Object Storage Service (OSS) bucket
    • ENI: an elastic network interface (ENI)
    • NLB: a Network Load Balancer (NLB) instance
    Note

    • If you set this parameter to ECS or SLB and the service-linked role AliyunServiceRoleForGaVpcEndpoint does not exist, the system automatically creates the service-linked role.

    • If you set this parameter to ALB and the service-linked role AliyunServiceRoleForGaAlb does not exist, the system automatically creates the service-linked role.

    • If you set this parameter to OSS and the service-linked role AliyunServiceRoleForGaOss does not exist, the system automatically creates the service-linked role.

    For more information, see Service linked roles.

    		Ip
    WeightlongNo

    The weight of the endpoint.

    Valid values: 0 to 255.

    You can set the weights of up to 100 endpoints in an endpoint group.

    Note
  • This parameter is required.
  • If you set the weight of an endpoint to 0, GA does not route network traffic to the endpoint. Make sure that you are aware of the impact on your business before you set the endpoint weight to 0.
    •
    		20
    EndpointstringNo

    The IP address, domain name, or instance ID based on the value of Type.

    You can specify up to 100 endpoint IP addresses or domain names in an endpoint group.

    Note This parameter is required.
    		47.0.XX.XX
    SubAddressstringNo

    The private IP address of the ENI.

    Note If you set Type to ENI, you can specify this parameter. If you do not specify this parameter, the primary private IP address of the ENI is used.
    		172.168.XX.XX
    EndpointRequestProtocolstringNo

    The protocol that is used by the backend service. Valid values:

    • HTTP (default)
    • HTTPS

    You can specify up to 10 backend service protocols.

    Note
  • You can specify this parameter only if the listener that is associated with the endpoint group uses HTTP or HTTPS.
  • For an HTTP listener, the backend service protocol must be HTTP.
    •
    		HTTP
    EndpointGroupTypestringNo

    The type of the endpoint group. Valid values:

    • default (default)
    • virtual

    You can specify the types of up to 10 endpoint groups.

    Note Only HTTP and HTTPS listeners support virtual endpoint groups.
    		default
    PortOverridesobject []No

    The port mapping.

    ListenerPortlongNo

    The listener port that is mapped to the endpoint port.

    You can specify up to five listener ports.

    Note
  • Only HTTP and HTTPS listeners support port mappings.
  • The listener port in a port mapping must be the port that is used by the current listener.
    •
    		443
    EndpointPortlongNo

    The endpoint port that is mapped to the listener port.

    You can specify up to five endpoint ports.

    		80
    EnableClientIPPreservationToabooleanNo

    Specifies whether to preserve the IP addresses of clients that access the endpoint by using the TCP Option Address (TOA) module. Valid values:

    • true
    • false (default)

    You can specify this parameter for up to 10 endpoint groups.

    		false
    EnableClientIPPreservationProxyProtocolbooleanNo

    Specifies whether to use the proxy protocol to preserve client IP addresses. Valid values:

    • true
    • false (default)

    You can specify this parameter for up to 10 endpoint groups.

    		false
    Tagobject []No

    The tags.

    KeystringNo

    The key of the tag.

    You can enter up to 20 tags.

    		tag-key
    ValuestringNo

    The value of the tag.

    You can enter up to 20 tags.

    		tag-value
    SystemTagobject []No

    The system tag.

    KeystringNo

    The key of the system tag.

    You can enter up to 20 system tags.

    		system-tag-key
    ValuestringNo

    The value of the system tag.

    You can enter up to 20 system tags.

    		system-tag-value
    ScopestringNo

    The visibility of the system tag. Valid values:

    • public (default): The system tag is visible and can be used for filtering.
    • private: The system tag is invisible.
    		public

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned data.

    RequestIdstring

    The ID of the request.

    		6FEA0CF3-D3B9-43E5-A304-D217037876A8
    EndpointGroupIdsarray

    The IDs of the endpoint groups.

    string

    The ID of the endpoint group.

    		epg-bp1dmlohjjz4kqaun****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400Domain.NotFitThe domain is not fit the ruleThe domain name does not have an ICP number.
    400Resource.QuotaFullThe resource quota is exceeded.The number of resources has reached the upper limit.
    400NoPermission.EnableHealthCheckYou do not have permission to enable health check.The current account does not have the permissions to enable health checks.
    400NotSupportHealthCheck.AcceleratorCurrently Accelerator does not support health check.The current GA instance does not support health checks.
    400EndpointGroupExclusive.ListenerAll endpoint group must under the same listener.All the endpoint groups must be associated with the same listener.
    400RegionConflict.EndpointGroupEndpoint 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.
    400ListenerProtocolIllegal.EndpointGroupListener 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.
    400QuotaExceeded.EndpointGroupThe number of endpoint group exceeds the limit.The number of endpoint groups has reached the upper limit.
    400ParamExclusive.EndpointGroupTypeAll endpoint group type group must be consistent.-
    400HealthCheckPath.IllegalHealth check path illegal.The health check path is invalid.
    400NotExist.ListenerThe listener does not exist.The listener does not exist.
    400NotActive.ListenerThe state of the listener is not active.The listener is unstable.
    400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.
    400StateError.AcceleratorThe state of the accelerated instance is invalid.The status of the GA instance is invalid.
    400NotExist.BusinessRegionThe business region does not exist.The business region does not exist.
    400NotExist.BasicBandwidthPackageYou must specify the basic bandwidth package.You must specify the basic bandwidth package.
    400QuotaExceeded.EndPointThe maximum number of endpoints is exceeded.The maximum number of endpoints is exceeded.
    400NoPermission.VpcEndpointYou 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.
    400EndPointRequestProtocolIllegal.EndpointGroupendpoint group request protoco is illegal-
    400QuotaExceeded.PortOverrideThe number of port override exceeds the limit.The number of port override exceeds the limit.
    400NotExist.ListenerPortlistener port %s is not exist-
    400MixedVpc.EndPointVPC Endpoint cannot be mixed with other types of Endpoints.You cannot use private endpoints with other types of endpoints.
    400IllegalPublicIp.EndPointThe 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.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-10-27The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-09-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-04-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-04-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change