All Products
Search

This Product

    Global Accelerator:CreateBasicEndpointGroup

    Document Center

    Global Accelerator:CreateBasicEndpointGroup

    Last Updated:Jul 31, 2024

    Creates an endpoint group for a basic Global Accelerator (GA) instance.

    Operation description

    • CreateBasicEndpointGroup is an asynchronous operation. After a request is sent, the system returns an endpoint group ID and runs the task in the background. You can call the GetBasicEndpointGroup operation to query the status of the task.

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

    • You cannot call the CreateBasicEndpointGroup operation again on the same GA instance before the previous request is completed.

    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:CreateBasicEndpointGroupcreate
    • BasicEndpointGroup
      acs:ga:{#regionId}:{#accountId}:endpointgroup/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the GA instance. 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.
    		123e4567-e89b-12d3-a456-426655440000
    AcceleratorIdstringYes

    The ID of the basic GA instance.

    		ga-bp17frjjh0udz4qz****
    EndpointGroupRegionstringYes

    The ID of the region to which the endpoint group belongs.

    You can call the ListAvailableBusiRegions operation to query the region ID.

    		cn-shanghai
    NamestringNo

    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.

    		group1
    DescriptionstringNo

    The description of the endpoint group.

    The description can be up to 200 characters in length and cannot start with http:// or https://.

    		BasicEndpointGroup
    EndpointTypestringNo

    The type of the endpoint. Valid values:

    • ENI
    • SLB
    • ECS
    		ENI
    EndpointAddressstringNo

    The endpoint address.

    		eni-bp1a05txelswuj8g****
    EndpointSubAddressstringNo

    The secondary address of the endpoint.

    You must specify this parameter when the accelerated IP address is associated with the secondary private IP address of an Elastic Compute Service (ECS) instance or an elastic network interface (ENI).

    • When the endpoint type is ECS, you can set EndpointSubAddress to the secondary private IP address of the primary ENI. If the parameter is left empty, the primary private IP address of the primary ENI is used.
    • If the endpoint type is ENI, you can set EndpointSubAddress to the secondary private IP address of the secondary ENI. If the parameter is left empty, the primary private IP address of the secondary ENI is used.
    		172.16.XX.XX

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    EndpointGroupIdstring

    The endpoint group ID.

    		epg-bp1dmlohjjz4kqaun****
    RequestIdstring

    The request ID.

    		04F0F334-1335-436C-A1D7-6C044FE73368

    Examples

    Sample success responses

    JSONformat

    {
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

    Error codes

    HTTP status codeError codeError messageDescription
    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.
    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.
    400Exist.EndpointGroupThe endpoint group already exists.The endpoint group already exists.
    400QuotaExceeded.EndpointGroupThe number of endpoint group exceeds the limit.The number of endpoint groups has reached the upper limit.
    400EcsCannotBind.BasicEndpointThe ECS instance has already been associated with another EIP.-
    400InvalidateRegion.BasicAcceleratorThe region of the endpoint group and the acceleration region cannot be the same.-
    500UnknownErrorAn 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 timeSummary of changesOperation
    2023-04-20The Error code has changedView Change Details
    2023-04-13The Error code has changedView Change Details