CreateCustomRoutingEndpointTrafficPolicies - Global Accelerator

Creates traffic destinations for an endpoint that is associated with a custom routing listener.

Operation description

This operation takes effect only when the traffic access policy of an endpoint allows traffic to specified destinations. You can call the DescribeCustomRoutingEndpoint operation to query the traffic access policy of an endpoint. This operation takes effect only if the value of TrafficToEndpointPolicy is set to AllowCustom, which allows traffic to specific destinations.

When you call this operation, take note of the following items:

CreateCustomRoutingEndpointTrafficPolicies 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, the traffic destinations are being created. In this state, you can only query the traffic destinations.
- If the endpoint group is in the active state, the traffic destinations are created.
You cannot call the CreateCustomRoutingEndpointTrafficPolicies operation repeatedly for the same GA instance in a specific period of time.

Prerequisites

Before you call this operation, make sure that the following requirements are met:

A standard GA instance is created. For more information, see CreateAccelerator .
If the bandwidth metering method of the standard GA instance is pay-by-bandwidth, a bandwidth plan must be associated with the standard GA instance. For more information, see BandwidthPackageAddAccelerator .
An application that serves as the endpoint of the standard GA instance is deployed to receive requests that are forwarded from GA. You can specify only vSwitches as endpoints for custom routing listeners.
The permissions to use custom routing listeners are acquired, and a custom routing listener is created. Custom routing listeners are in invitational preview. To use custom routing listeners, contact your account manager. For more information about how to create a custom routing listener, see CreateListener .
Endpoint groups are created for the custom routing listener. For more information, see CreateCustomRoutingEndpointGroups .
Endpoints are created for the custom routing listener. For more information, see CreateCustomRoutingEndpoints .

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:CreateCustomRoutingEndpointTrafficPolicies	create	CustomRoutingEndpointTrafficPolicy acs:ga:{#regionId}:{#accountId}:customroutingendpoint/{#CustomRoutingEndpointId}	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 token, but you must make sure that the token is unique among all requests. The 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 for each API request is different.	123e4567-e89b-12d3-a456-426655440000
EndpointId	string	Yes	The ID of the endpoint for which you want to create traffic destinations.	ep-2zewuzypq5e6r3pfh****
PolicyConfigurations	array<object>	Yes	The configurations of the traffic destinations. You can specify up to 500 traffic destinations for each endpoint.
	object	Yes	The configurations of the traffic destinations. You can specify up to 500 traffic destinations for each endpoint.
Address	string	No	The IP address of the destination to which traffic is forwarded. This parameter takes effect only when TrafficToEndpointPolicy is set to AllowCustom. You can specify up to 500 destination IP addresses for each endpoint. Note This parameter is required.	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 500 traffic destinations in each endpoint and specify up to 10 port ranges for each traffic 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 traffic destinations in each endpoint and specify up to 20 port ranges for each traffic destination.
FromPort	integer	No	The first port of the destination port range. The value of this parameter must fall within the port range of the endpoint group. This parameter takes effect only when TrafficToEndpointPolicy is set to AllowCustom. If the first port and the last port are not specified, traffic on all ports of the destination is allowed. You can specify port ranges for up to 500 destinations in each endpoint and specify up to 10 first ports for each destination.	80
ToPort	integer	No	The last port of the destination port range. The value of this parameter must fall within the port range of the endpoint group. This parameter takes effect only when TrafficToEndpointPolicy is set to AllowCustom. If the first port and the last port are not specified, traffic on all ports of the destination is allowed. You can specify port ranges for up to 500 destinations in each endpoint and specify up to 10 last ports for each destination.	80

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-23	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