All Products
Search

This Product

    Global Accelerator:UpdateBasicEndpointGroup

    Document Center

    Global Accelerator:UpdateBasicEndpointGroup

    Last Updated:Apr 10, 2024

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

    Operation description

    • UpdateBasicEndpointGroup is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. The system modifies the configurations of an endpoint group that is associated with a basic GA instance by deleting the endpoint group and creating a new endpoint group. You can call the GetBasicAccelerator operation to query the status of the task.

      • If the basic GA instance is in the configuring state, 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, the configurations of the endpoint group are modified.

    • The UpdateBasicEndpointGroup operation cannot be repeatedly called 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.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the region where the basic 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.
    		123e4567-e89b-12d3-a456-426655440000
    EndpointGroupIdstringYes

    The ID of the endpoint group.

    		epg-bp1dmlohjjz4kqaun****
    NamestringNo

    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.

    		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: elastic network interface (ENI).
    • SLB: Classic Load Balancer (CLB) instance.
    • ECS: Elastic Compute Service (ECS) instance.
    		ENI
    EndpointAddressstringNo

    The address of the endpoint.

    		eni-bp1a05txelswuj8g****
    EndpointSubAddressstringNo

    The secondary address of the endpoint.

    This parameter is required only if the accelerated IP address is associated with the secondary private IP address of an ECS instance or an ENI.

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

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400NotExist.EndPointGroupThe endpoint group does not exist.The endpoint group does not exist.
    400StateError.EndPointGroupThe specified state of endpoint group is invalid.The endpoint group is in an invalid state.
    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.

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

    Change history

    Change timeSummary of changesOperation
    No change history