Modifies the 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 system background. You can call the DescribeCustomRoutingEndpointGroup operation to query the state of the endpoint groups associated with a custom routing listener to check whether the endpoints in the endpoint groups are modified.
- If an endpoint group is in the updating state, the endpoints in the endpoint group are being modified. In this case, you can perform only query operations.
- If an endpoint group is in the active state, the endpoints in the endpoint group are modified.
-
The UpdateCustomRoutingEndpoints operation cannot be repeatedly called for the same Global Accelerator (GA) instance within a specific period of time.
Debugging
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 Resourcesis 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:UpdateCustomRoutingEndpoints | update |
|
| 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 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.
| 123e4567-e89b-12d3-a456-426655440000 |
| EndpointGroupId | string | Yes | The ID of the endpoint group to which the endpoints that you want to modify belong. | epg-bp1bpn0kn908w4nb**** |
| EndpointConfigurations | array<object> | Yes | The configurations of the endpoint. | |
| object | Yes | The configurations of the endpoint. | ||
| TrafficToEndpointPolicy | string | No | The access policy of traffic for the specified endpoint. Default value: DenyAll. Valid values:
You can specify up to 20 access policies of traffic 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 configurations of the policy. | |
| object | No | The configurations of the policy. | ||
| 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 parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"EndpointIds": [
"ep-bp1dmlohjjz4kqaun****"
]
}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 |