Modifies the configurations of an endpoint group that is associated with a basic Global Accelerator (GA) instance.

Description

  • UpdateBasicEndpointGroup is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. After you call this operation to modify an endpoint group that is associated with a basic GA instance, the system deletes the endpoint group and creates another endpoint group in the background for the basic GA instance. You can call the GetBasicAccelerator operation to query the state of the basic GA instance.
    • If the basic GA instance is in the configuring state, it indicates that the configurations of the endpoint group are being modified. In this case, you can perform only query operations.
    • If the basic GA instance is in the active state, it indicates that the configurations of the endpoint group are modified.
  • The UpdateBasicEndpointGroup operation cannot be called repeatedly for the same basic 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateBasicEndpointGroup

The operation that you want to perform. Set the value to UpdateBasicEndpointGroup.

RegionId String Yes cn-hangzhou

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

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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 make sure that it is unique among different requests. The ClientToken value contain only ASCII characters.

Note If you do not specify this parameter, the system uses RequestId as ClientToken. The value of RequestId of each API request may be different.
EndpointGroupId String Yes epg-bp1dmlohjjz4kqaun****

The ID of the endpoint group that is associated with the basic GA instance.

Name String No group1

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.

Description String No BasicEndpointGroup

The description of the endpoint group.

The description cannot exceed 256 characters in length and cannot contain http:// or https://.

EndpointType String No ENI

The type of endpoint. Valid values:

  • ENI: elastic network interface (ENI)
  • SLB: Classic Load Balancer (CLB)
  • ECS: Elastic Compute Service (ECS)
EndpointAddress String No eni-bp1a05txelswuj8g****

The address of the endpoint.

EndpointSubAddress String No 172.16.XX.XX

The secondary address of the endpoint.

This parameter is required when the accelerated IP address is associated with the secondary private IP address of an ECS instance or 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.
  • When 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.

Response parameters

Parameter Type Example Description
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the region.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateBasicEndpointGroup
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&EndpointGroupId=epg-bp1dmlohjjz4kqaun****
&Name=group1
&Description=BasicEndpointGroup
&EndpointType=ENI
&EndpointAddress=eni-bp1a05txelswuj8g****
&EndpointSubAddress=172.16.XX.XX
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateBasicEndpointGroupResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</UpdateBasicEndpointGroupResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code Error code Error message Description
400 NotExist.EndPointGroup The endpoint group does not exist. The error message returned because the specified endpoint group does not exist.
400 StateError.EndPointGroup The specified state of endpoint group is invalid. The error message returned because the specified endpoint group is in an invalid state.
400 NotExist.Accelerator The accelerated instance does not exist. The error message returned because the specified GA instance does not exist.
400 StateError.Accelerator The state of the accelerated instance is invalid. The error message returned because the specified GA instance is in an invalid state.

For a list of error codes, see Service error codes.