Use UpdateCustomRoutingEndpoints to modify endpoints of a custom routing listener - Global Accelerator - Alibaba Cloud - Global Accelerator

Modifies endpoints of a custom routing listener.

Operation description

Description

UpdateCustomRoutingEndpoints is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the background. You can call the DescribeCustomRoutingEndpointGroup operation to query the state of the endpoint groups associated with a custom routing listener and check whether the endpoints are modified.
- If an endpoint group is in the updating state, the endpoints are being modified. In this case, you can perform only query operations.
- If an endpoint group is in the active state, the endpoints are modified.
The UpdateCustomRoutingEndpoints operation cannot be called repeatedly for the same Global Accelerator (GA) instance within a specific period of time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:UpdateCustomRoutingEndpoints

update

*CustomRoutingEndpointGroup

acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#EndpointGroupId}

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 client token can contain only ASCII characters. Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426655440000
EndpointGroupId	string	Yes	The ID of the endpoint group that contains the endpoints you want to modify.	epg-bp1bpn0kn908w4nb****
EndpointConfigurations	array<object>	Yes	The endpoint configurations.
	array<object>	No	The endpoint configurations.
TrafficToEndpointPolicy	string	No	The access policy of traffic for the specified endpoint. Default value: DenyAll. Valid values: DenyAll: denies all traffic to the endpoint. AllowAll: allows all traffic to the endpoint. AllowCustom: allows traffic only to specified destinations. If you set this parameter to AllowCustom, you must specify destination IP addresses and port ranges. If you specify only IP addresses without port ranges, GA forwards traffic to all ports on the specified IP addresses. You can configure up to 20 access policies for the specified endpoint.	DenyAll
EndpointId	string	No	The ID of the endpoint. You can specify up to 20 endpoint IDs.	ep-bp1dmlohjjz4kqaun****
PolicyConfigurations	array<object>	No	The policy configurations.
	array<object>	No	The policy configurations.
Address	string	No	The IP address of the destination to which to allow traffic. This parameter takes effect only when TrafficToEndpointPolicy is set to AllowCustom. You can specify up to 20 destination IP addresses for each endpoint.	10.0.XX.XX
PortRanges	array<object>	No	The port range of the destination to which traffic is forwarded. The value of this parameter must fall within the port range of the endpoint group. If you leave this parameter empty, traffic is forwarded to all destination ports. This parameter takes effect only when TrafficToEndpointPolicy is set to AllowCustom. You can specify port ranges for up to 20 destinations for each endpoint and specify up to 20 port ranges for each destination.
	object	No	The port range of the destination to which traffic is forwarded. The value of this parameter must fall within the port range of the endpoint group. If you leave this parameter empty, traffic is forwarded to all destination ports. This parameter takes effect only when TrafficToEndpointPolicy is set to AllowCustom. You can specify port ranges for up to 20 destinations for each endpoint and specify up to 20 port ranges for each destination.
FromPort	string	No	The start port of the port range in the destination to which to allow traffic. The specified port must fall within the port range of the specified endpoint group. This parameter takes effect only when TrafficToEndpointPolicy is set to AllowCustom. You can specify port ranges for up to 20 destinations for each endpoint and specify up to 20 start ports for each destination.	80
ToPort	string	No	The end port of the port range in the destination to which to allow traffic. The specified port must fall within the port range of the specified endpoint group. This parameter takes effect only when TrafficToEndpointPolicy is set to AllowCustom. You can specify port ranges for up to 20 destinations for each endpoint and specify up to 20 end ports for each destination.	80

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368
EndpointIds	array	The IDs of the endpoints.
	string	The IDs of the endpoints.	ep-bp1dmlohjjz4kqaun****

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "EndpointIds": [
    "ep-bp1dmlohjjz4kqaun****"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.EndPointGroup	endpoint group %s is not exist	The endpoint group %s does not exist.
400	NotExist.Listener	listener %s is not exist	The listener %s does not exist.
400	StateError.EndPointGroup	endpoint group state %s is illegal	The endpoint group is in an invalid state.
400	NotActive.Listener	listener %s is not active	The listener %s is unavailable.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.