Modifies endpoint group mappings for custom routing listeners.

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 state of an endpoint group associated with a custom route listener to check whether the mappings of the endpoint group is modified.
    • If the endpoint group is in the updating state, the mappings 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 mappings 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateCustomRoutingEndpointGroupDestinations

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

RegionId String Yes cn-hangzhou

The ID of the region where the 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 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.
DryRun Boolean No false

Specifies whether to only precheck the request. Default value: false. Valid values:

  • true: prechecks the request without performing the operation. The system checks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: sends the request. If the request passes the precheck, a 2xx HTTP status code is returned and the operation is performed.
EndpointGroupId String No epg-bp1dmlohjjz4kqaun****

The ID of the endpoint group.

DestinationConfigurations.N.Protocols.N String No tcp

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 for each endpoint group.

DestinationConfigurations.N.FromPort Integer No 80

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 of backend service port ranges in each request.

DestinationConfigurations.N.ToPort Integer No 80

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 of backend service port ranges in each request.

DestinationConfigurations.N.DestinationId String No dst-abc123****

The ID of the mapping configuration of the endpoint group.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateCustomRoutingEndpointGroupDestinations
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&EndpointGroupId=epg-bp1dmlohjjz4kqaun****
&DestinationConfigurations=[{"Protocols":["tcp"],"FromPort":80,"ToPort":80,"DestinationId":"dst-abc123****"}]
&<Common request parameters>

Sample success responses

XML format

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

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

JSON format

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

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

Error codes

For a list of error codes, visit the API Error Center.