DescribeTransitRouterPolicyBasedRoutes - 查询企业版转发路由器策略路由表中的策略路由规则信息

更新时间:
复制 MD 格式

查询企业版转发路由器策略路由表中的策略路由规则信息。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cen:DescribeTransitRouterPolicyBasedRoutes

get

*全部资源

*

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

PolicyTableId

string

否

策略路由表实例 ID。

ptbl-abc123xyz

MaxResults

integer

否

分批次查询时每次显示的条目数。取值范围:1~100,默认值:20.

20

NextToken

string

否

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

FFmyTO70tTpLG6I3FmYAXGKPd****

Filter

array<object>

否

过滤条件的信息。

一次最多支持输入 5 个过滤条件。

object

否

过滤条件的信息。

一次最多支持输入 5 个过滤条件。

Key

string

否

过滤条件。取值:

  • PolicyBasedRouteId:策略路由规则实例 ID。

多个过滤条件之间默认是与的关系,即必须符合所有过滤条件,才视为匹配过滤条件。

一次最多支持输入 5 个过滤条件。

PolicyBasedRouteId

Value

array

否

过滤条件的值。

根据 Key 指定过滤值。一个 Key 支持指定多个过滤值,多个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。

一个过滤条件最多支持输入 5 个过滤值。

string

否

过滤条件的值。

根据 Key 指定过滤值。一个 Key 支持指定多个过滤值,多个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。

一个过滤条件最多支持输入 5 个过滤值。

pbr-123qweasd

返回参数

名称

类型

描述

示例值

object

Schema of Response

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

FFmyTO70tTpLG6I3FmYAXGKPd****

RequestId

string

请求 ID。

F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1

TotalCount

integer

总条目数。

4

MaxResults

integer

分批次查询时,每次显示的条目数。默认值为 20。

20

PolicyBasedRoutes

array<object>

策略路由规则列表。

object

PolicyBasedRouteId

string

策略路由规则的实例 ID。

pbr-123qwead

PolicyTableId

string

策略路由表实例 ID。

ptbl-123adsfzc

Priority

integer

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

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

1

SourceCidr

string

源网段。

10.0.0.0/8

DestinationCidr

string

目标网段。

10.185.33.0/24

Protocol

string

流量报文的协议类型。

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

TCP

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 的流量。

1/10

TargetRouteTableId

string

目标路由表。

vtb-123adf

Name

string

策略路由规则的名称。

名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。

None

Description

string

策略路由表实例的描述信息。

OK

Status

string

策略路由的状态。

  • Creating:创建中。

  • Active:可用。

  • Deleting:删除中。

Active

AddressFamily

string

地址族。可能值:

  • IPv4。

  • IPv6。

IPv4

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount": 4,
  "MaxResults": 20,
  "PolicyBasedRoutes": [
    {
      "PolicyBasedRouteId": "pbr-123qwead",
      "PolicyTableId": "ptbl-123adsfzc",
      "Priority": 1,
      "SourceCidr": "10.0.0.0/8",
      "DestinationCidr": "10.185.33.0/24",
      "Protocol": "TCP",
      "SourcePortRange": "80/80",
      "DestPortRange": "80/80",
      "Dscp": "1/10",
      "TargetRouteTableId": "vtb-123adf",
      "Name": "None",
      "Description": "OK",
      "Status": "Active",
      "AddressFamily": "IPv4"
    }
  ]
}

错误码

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

变更历史

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