CreateTransitRouterPolicyBasedRoute-阿里云帮助中心

Creates a policy-based routing rule in the policy route table of an Enterprise Edition transit router.

Operation description

The CreateTransitRouterPolicyBasedRoute operation is asynchronous. After you call this operation, the system returns a route entry ID, but the route entry is not completely created and the creation task is still running in the background. You can call the DescribeTransitRouterPolicyBasedRoutes operation to query the status of the route entry.

If the route entry is in the Creating state, the route entry is being created. In this state, you can only query the route entry and cannot perform other operations.
If the route entry is in the Active state, the route entry is created.

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

cen:CreateTransitRouterPolicyBasedRoute

create

TransitRouterPolicyBasedRoute

acs:cen:*:{#accountId}:centransitrouterpolicybasedroute/*

TransitRouterPolicyTable

acs:cen:*:{#accountId}:centransitrouterpolicytable/{#centransitrouterpolicytableId}

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
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 the value is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.	123e4567-e89b-12d3-a456-42665544****
DryRun	boolean	No	Specifies whether to perform a dry run on the request. Valid values: true: performs a dry run and does not create the routing rule entry in the policy route table. The system checks whether the required parameters are specified, the request format is valid, and the service limits are met. 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 (default): performs a dry run and creates the routing rule entry in the policy route table if the request passes the dry run.	false
PolicyTableId	string	Yes	The instance ID of the policy-based routing table.	ptbl-abc123xyz
Priority	integer	Yes	The priority of the policy-based routing rule. Valid values: 1 to 100. The priority of each policy-based routing rule in a policy route table of a transit router must be unique. A smaller value indicates a higher priority.	3
TargetRouteTableId	string	Yes	The destination route table.	vtb-123abcxyz
SourceCidr	string	No	The source CIDR block. The source CIDR block must be in CIDR format. Example: 192.168.1.0/24.	10.0.0.0/8
DestinationCidr	string	No	The destination CIDR block of the route entry. Both IPv4 and IPv6 addresses are supported.	172.19.2.0/24
AddressFamily	string	No	The address family. Valid values: IPv4 IPv6	IPv4
Protocol	string	No	The protocol type of the traffic packet. Traffic classification rules support matching traffic of various protocol types, such as HTTP, HTTPS, TCP, UDP, SSH, and Telnet. For more protocol types, log on to the Cloud Enterprise Network (CEN) console.	ICMP
SourcePortRange	string	No	The source port. Valid values: -1 or 1 to 65535. Matches traffic whose port number falls within the source port range. If this parameter is not specified, traffic from any source port is matched. The port range is specified in the following formats: 80: specifies port 80. 80/80: specifies port 80. 1/200: specifies ports 1 to 200. -1/-1: specifies all ports.	80/80
DestPortRange	string	No	The destination port. Valid values: -1 or 1 to 65535. Matches traffic whose port number falls within the destination port range. If this parameter is not specified, traffic to any destination port is matched. The port range is specified in the following formats: 80: specifies port 80. 80/80: specifies port 80. 1/200: specifies ports 1 to 200. -1/-1: specifies all ports.	80/80
Dscp	string	No	The Differentiated Services Code Point (DSCP) value of the traffic packet to be matched. Valid values: 0 to 63. The DSCP value range is specified in the following formats: 1: matches traffic with a DSCP value of 1. 1/10: matches traffic with a DSCP value from 1 to 10. -1/-1: matches traffic with any DSCP value.	10
Name	string	No	The name of the policy-based routing rule.	nametest
Description	string	No	The description of the policy-based routing rule.	desctest

Response elements

Element	Type	Description	Example
	object	Schema of Response
PolicyBasedRouteId	string	The instance ID of the policy-based routing rule.	pbr-123abczxc
RequestId	string	The request ID.	13526224-5780-4426-8BDF-BC8B08700F22

Examples

Success response

JSON format

{
  "PolicyBasedRouteId": "pbr-123abczxc",
  "RequestId": "13526224-5780-4426-8BDF-BC8B08700F22"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InstanceNotExist.PolicyTable	The policy table does not exist.	The policy table does not exist.
400	InvalidParameter.PolicyTableId	The specified parameter PolicyTableId is invalid.	The parameter PolicyTableId entered is illegal.
400	InvalidParameter.TargetRouteTableId	The specified parameter TargetRouteTableId is invalid.	The parameter TargetRouteTableId entered is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.