Update Custom Routing Endpoint Destinations via API - Global Accelerator - Alibaba Cloud - Global Accelerator

Modifies the mapping configurations of an endpoint group associated with a custom routing listener.

Operation description

UpdateCustomRoutingEndpointGroupDestinations is an asynchronous operation. After you send a request, the system returns a request ID while the operation continues in the background. You can call the DescribeCustomRoutingEndpointGroup operation to query the status of the endpoint group and check whether the mapping configurations are modified.
- If the endpoint group is in the updating state, the mapping configurations are being modified. In this case, you can perform only query operations.
- If the endpoint group is in the active state, the mapping configurations are modified.
The UpdateCustomRoutingEndpointGroupDestinations 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:UpdateCustomRoutingEndpointGroupDestinations

update

*CustomRoutingEndpointGroupDestination

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

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 ensures the idempotence of the request. You can use the client to generate the token, but you must ensure that the value is unique among all requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the value of RequestId as the value of ClientToken. The value of RequestId for each API request may be different.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and 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: performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
EndpointGroupId	string	Yes	The ID of the endpoint group.	epg-bp1dmlohjjz4kqaun****
DestinationConfigurations	array<object>	Yes	The mapping configurations of the endpoint group. Specify the backend service port range and protocol for the endpoint group. This information maps to the port range of the associated listener. You can specify at most 20 mapping configurations, which include port ranges and protocol types.
	object	No	The mapping configuration of the endpoint group. Specify the backend service port range and protocol for the endpoint group. This information maps to the port range of the associated listener. You can specify at most 20 mapping configurations, which include port ranges and protocol types.
Protocols	array	No	The backend service protocol for the endpoint group. Valid values: tcp: TCP udp: UDP tcp,udp: TCP and UDP You can specify up to four backend service protocols in each configuration.
	string	No	The backend service protocol for the endpoint group. Valid values: tcp: TCP udp: UDP tcp,udp: TCP and UDP You can specify up to four backend service protocols in each configuration.	tcp
FromPort	integer	No	The start port of the backend service port range for the endpoint group. Valid values: 1 to 65499. The FromPort value must be smaller than or equal to the ToPort value. You can specify up to 20 start ports in each request.	80
ToPort	integer	No	The end port of the backend service port range for the endpoint group. Valid values: 1 to 65499. The FromPort value must be smaller than or equal to the ToPort value. You can specify up to 20 end ports in each request.	80
DestinationId	string	Yes	The ID of the mapping configuration of the endpoint group.	dst-abc123****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

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

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	StateError.EndPointGroup	endpoint group state %s is illegal	The endpoint group is in an invalid state.
400	NotExist.Listener	listener %s is not exist	The listener %s does not exist.
400	NotActive.Listener	listener %s is not active	The listener %s is unavailable.
400	NotExist.Accelerator	accelerator %s is not exist	The GA instance %s does not exist.
400	StateError.Accelerator	accelerator state %s is illegal	The GA instance is in an invalid state %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.