Use UpdateCustomRoutingEndpointTrafficPolicies to modify traffic policies for an endpoint - Global Accelerator - Alibaba Cloud - Global Accelerator

Modifies traffic policies for an endpoint associated with a custom routing listener.

Operation description

UpdateCustomRoutingEndpointTrafficPolicies is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeCustomRoutingEndpointGroup operation to query the status of the task.
- If the endpoint group is in the updating state, traffic policies are being modified. You can perform only query operations.
- If the endpoint group is in the active state, the traffic policies have been modified.
UpdateCustomRoutingEndpointTrafficPolicies 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:UpdateCustomRoutingEndpointTrafficPolicies

update

*CustomRoutingEndpointTrafficPolicy

acs:ga:{#regionId}:{#accountId}:customroutingendpoint/{#CustomRoutingEndpointTrafficPolicyId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Global Accelerator (GA) instance. 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 ensure that the token is unique among requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
EndpointId	string	Yes	The endpoint ID.	ep-2zewuzypq5e6r3pfh****
PolicyConfigurations	array<object>	Yes	The access policies. You can specify up to 500 traffic policies for each endpoint.
	array<object>	No	The traffic policies. You can specify up to 500 destination IP addresses for each endpoint.
PolicyId	string	No	The ID of the traffic policy that you want to modify. Note This parameter is required.	ply-bptest2****
Address	string	No	The IP address of the traffic destination. This parameter takes effect only if TrafficToEndpointPolicy is set to AllowCustom. You can call the DescribeCustomRoutingEndpoint operation to query the traffic policy of an endpoint. You can specify up to 500 traffic policies for each endpoint. Note This parameter is required.	10.0.XX.XX
PortRanges	array<object>	No	The port range of the traffic destination. The value must fall within the port range of the endpoint group. If you leave this parameter empty, traffic is forwarded to all ports. This parameter takes effect only if TrafficToEndpointPolicy is set to AllowCustom. You can call the DescribeCustomRoutingEndpoint operation to query the traffic policy of an endpoint. You can specify up to 500 port ranges for each endpoint and up to 10 port ranges for each traffic policy.
	object	No	The port range of the traffic destination. The value must fall within the port range of the backend service. If you leave this parameter empty, traffic is forwarded to all ports. This parameter takes effect only if TrafficToEndpointPolicy is set to AllowCustom. You can call the DescribeCustomRoutingEndpoint operation to query the traffic policy of an endpoint. You can specify port ranges for up to 500 traffic destinations in each endpoint and up to 10 port ranges for each traffic destination.
FromPort	integer	No	The start port of the destination port range. The value must fall within the port range of the backend service. This parameter takes effect only if TrafficToEndpointPolicy is set to AllowCustom. You can call the DescribeCustomRoutingEndpoint operation to query the traffic policy of an endpoint. If both the start port and end port are empty, traffic on all destination ports is allowed. You can specify up to 500 port ranges for each endpoint and up to 10 port ranges for each traffic policy.	80
ToPort	integer	No	The end port of the destination port range. The value must fall within the port range of the backend service. This parameter takes effect only if TrafficToEndpointPolicy is set to AllowCustom. You can call the DescribeCustomRoutingEndpoint operation to query the traffic policy of an endpoint. If both the start port and end port are empty, traffic on all destination ports is allowed. You can specify up to 500 port ranges for each endpoint and up to 10 port ranges for each traffic policy.	80

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
PolicyIds	array	The IDs of the traffic destinations.
	string	The IDs of the traffic destinations.	ply-bptest2****

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PolicyIds": [
    "ply-bptest2****"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.EndPoints	endpoint %s not exist.	Endpoint% s does not exist
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.