UpdateCustomRoutingEndpointGroupDestinations - Global Accelerator

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

Operation description

UpdateCustomRoutingEndpointGroupDestinations 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. You can call the DescribeCustomRoutingEndpointGroup operation to query the status of an endpoint group associated with a custom routing listener to check whether the mapping configurations of the endpoint group are modified.
- If the endpoint group is in the updating state, the mapping configurations of the endpoint group are being modified. In this case, you can perform only query operations.
- If the endpoint group is in the active state, the mapping configurations of the endpoint group are modified.
The UpdateCustomRoutingEndpointGroupDestinations operation cannot be repeatedly called for the same Global Accelerator (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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ga:UpdateCustomRoutingEndpointGroupDestinations	update	CustomRoutingEndpointGroupDestination acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#customroutingendpointgroupId}	none	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 value, but you must ensure that it 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 endpoint group. You must specify the backend service port range and protocol of the endpoint group. The specified information is used to map the port range of the associated listener. You can specify at most 20 mapping configurations, which include port ranges and protocol types.
	object	Yes	The mapping configuration of endpoint group. You must specify the backend service port range and protocol of the endpoint group. The specified information is used to map 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 of 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 of 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 of 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 of 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 parameters

Parameter	Type	Description	Example
	object	The returned information.
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-11	The Error code has changed	View Change Details
2023-04-20	The internal configuration of the API is changed, but the call is not affected	View Change Details