CreateTransitRouterPolicyBasedRoute - 在企业版转发路由器的策略路由表中添加路由规则

更新时间:
复制 MD 格式

在企业版转发路由器的策略路由表中添加策略路由规则。

接口说明

CreateTransitRouterPolicyBasedRoute 接口属于异步接口,即系统会先返回一个路由条目 ID,但该路由条目并未创建完成,系统后台的创建任务仍在进行。您可以调用 DescribeTransitRouterPolicyBasedRoutes 接口查询路由条目的状态。

  • 当路由条目处于 Creating 状态时,表示路由条目正在创建中。在该状态下,您只能对该路由条目执行查询操作,不能执行其他操作。

  • 当路由条目处于 Active 状态时,表示路由条目创建完成。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cen:CreateTransitRouterPolicyBasedRoute

create

TransitRouterPolicyBasedRoute

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

TransitRouterPolicyTable

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

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ClientToken

string

否

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明

若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。

123e4567-e89b-12d3-a456-42665544****

DryRun

boolean

否

是否只预检此次请求。取值:

  • true:发送检查请求,不会在策略路由表中创建路由规则条目。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation。

  • false(默认值):发送正常请求,通过检查后直接在策略路由表中创建路由规则条目。

false

PolicyTableId

string

是

策略路由表实例 ID。

ptbl-abc123xyz

Priority

integer

是

策略路由的优先级。取值范围:1~100。

一个转发路由器策略路由表实例下,每个策略路由的优先级需保证唯一。数字越小,优先级越高。

3

TargetRouteTableId

string

是

目标路由表。

vtb-123abcxyz

SourceCidr

string

否

源网段。源网段格式为 CIDR 格式。例如:192.168.1.0/24。

10.0.0.0/8

DestinationCidr

string

否

路由条目的目标网段,支持 IPv4 地址和 IPv6 地址。

172.19.2.0/24

AddressFamily

string

否

地址族。可能值:

  • IPv4。

  • IPv6。

IPv4

Protocol

string

否

流量报文的协议类型。

流分类规则支持匹配 HTTP、HTTPS、TCP、UDP、SSH、Telnet 等多种协议类型的流量。更多协议类型,请登录云企业网管理控制台查看。

ICMP

SourcePortRange

string

否

源端口。取值范围:-1或 1~65535。

匹配端口号在源端口范围中的流量,如果不设置则代表匹配任意源端口号的流量。

端口范围输入格式说明如下:

  • 80,表示端口 80。

  • 80/80,表示端口 80。

  • 1/200,表示端口范围 1 至 200。

  • -1/-1,表示匹配任意端口。

80/80

DestPortRange

string

否

目的端口。取值范围:-1或 1~65535。

匹配端口号在目的端口范围中的流量,如果不设置则代表匹配任意目的端口号的流量。

端口范围输入格式说明如下:

  • 80,表示端口 80。

  • 80/80,表示端口 80。

  • 1/200,表示端口范围 1 至 200。

  • -1/-1,表示匹配任意端口。

80/80

Dscp

string

否

匹配流量报文的 DSCP(Differentiated Services Code Point)值。取值范围:0~63。

端口范围输入格式说明如下:

  • 1,表示匹配 dscp 为 1 的流量。

  • 1/10,表示匹配 dscp1 至 10 的流量。

  • -1/-1,表示匹配任意 dscp 的流量。

10

Name

string

否

策略路由的名称。

nametest

Description

string

否

策略路由的描述信息。

desctest

返回参数

名称

类型

描述

示例值

object

Schema of Response

PolicyBasedRouteId

string

策略路由规则的实例 ID。

pbr-123abczxc

RequestId

string

请求 ID。

13526224-5780-4426-8BDF-BC8B08700F22

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 InstanceNotExist.PolicyTable The policy table does not exist. 转发路由器策略路由表不存在。
400 InvalidParameter.PolicyTableId The specified parameter PolicyTableId is invalid. 输入的参数PolicyTableId不合法。
400 InvalidParameter.TargetRouteTableId The specified parameter TargetRouteTableId is invalid. 输入的参数TargetRouteTableId不合法。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。