You need to enable JavaScript to run this app.
文档中心
中转路由器

中转路由器

复制全文
下载 pdf
路由策略
DescribeTransitRouterRoutePolicyEntries - 查询路由策略条目列表
复制全文
下载 pdf
DescribeTransitRouterRoutePolicyEntries - 查询路由策略条目列表
调用DescribeTransitRouterRoutePolicyEntries接口,查询满足指定条件的路由策略条目。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeTransitRouterRoutePolicyEntries​
接口名称。当前 API 的名称为DescribeTransitRouterRoutePolicyEntries。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为2020-04-01。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数,取值范围为1 ~ 100,默认值为20。​
​
PageNumber Integer 可选 示例值:1​
列表的页码,默认值为1。​
​
TransitRouterRoutePolicyTableId String 必选 示例值:tr-rpt-hy13n2l4c6c0v****​
路由策略的ID。您可以调用DescribeTransitRouterRoutePolicyTables接口获取路由策略的ID。​
​
TransitRouterRoutePolicyEntryIds.N String 可选 示例值:tr-rpe-13f1fdx5l****​
路由策略条目的ID。​
​
Direction String 可选 示例值:In​
路由策略的作用方向。取值如下:​
  • In:收方向。指中转路由器从网络实例学习路由时,只接收符合路由策略的路由。​
  • Out:发方向。指中转路由器向网络实例同步路由时,只发送符合路由策略的路由。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
PageSize Integer 示例值:20​
当前分页的行数。​
​
PageNumber Integer 示例值:1​
当前页码。​
​
TotalCount Integer 示例值:1​
符合条件的路由策略条目的总数。​
​
TransitRouterRoutePolicyEntries Object[] 示例值:--​
符合条件的路由策略条目的详细信息。​
IpPrefixMatchMode String 示例值:Complete​
路由前缀的匹配模式。​
  • Include:包含匹配。匹配条件中的路由前缀包含被匹配路由的路由前缀即判定为匹配成功。例如:路由前缀为10.10.0.0/16 的策略条目可以模糊匹配到目标网段为10.10.1.0/24的路由。​
  • Complete:精确匹配。匹配条件中的路由前缀必须与被匹配路由的路由前缀一致,才判定为匹配成功。例如:路由前缀为10.10.0.0/16 的策略条目仅可以精确匹配到目标网段为10.10.0.0/16的路由。​
​
TransitRouterRoutePolicyTableId String 示例值:tr-rpt-hy13n2l4c6c0v****​
路由策略的ID。​
​
TransitRouterRoutePolicyEntryId String 示例值:tr-rpe-13f1fdx5l****​
路由策略条目的ID。​
​
Description String 示例值:for test​
路由策略条目的描述信息。​
​
Status String 示例值:Available​
路由策略条目的状态。​
  • Creating: 创建中。​
  • Deleting: 删除中。​
  • Pending:配置中。​
  • Available:可用。​
​
Priority Integer 示例值:100​
路由策略条目的优先级,数字越小优先级越高。​
​
IpPrefixes String[] 示例值:192.168.XX.XX/24​
路由策略条目的路由前缀。​
​
SourceResourceTypes String[] 示例值:VPC​
路由策略条目的源实例类型。​
  • VPC:私有网络。​
  • DirectConnectGateway:专线网关。​
  • TransitRouter:跨地域TR。​
​
SourceResourceIds String[] 示例值:vpc-bp1aevy8sofi8mh1****​
路由策略条目的源实例ID。​
​
DestinationResourceTypes String[] 示例值:VPC​
路由策略条目的目的实例类型。​
  • VPC:私有网络。​
  • DirectConnectGateway:专线网关。​
  • TransitRouter:跨地域TR。​
​
DestinationResourceIds String[] 示例值:vpc-bp1aevy8sofi8mh1****​
路由策略条目的目的实例ID。​
​
ActionResult String 示例值:Permit​
路由策略条目的策略行为。​
  • Permit:允许。指允许匹配该路由策略条目的路由通过。​
  • Deny:拒绝。指拒绝匹配该路由策略条目的路由通过。​
​
AsPathOperateMode String 示例值:Additive​
路由策略条目的AsPath设置方式。​
  • Additive:追加AsPath。指在允许通过的路由的AsPath最前面追加指定的AsPath。​
  • Replace:替换AsPath。指使用指定的AsPath替换允许通过的路由的AsPath。​
​
ApplyAsPathValues Integer[] 示例值:65001​
路由策略条目设置的路由AsPath。​
​
CreationTime String 示例值:2023-08-14T18:05:17+08:00​
路由策略条目的创建时间。​
​
UpdateTime String 示例值:2023-08-14T18:05:17+08:00​
路由策略条目的更新时间。​
​
PrefixListId String 示例值:pl-1234567890abcdef0​
路由策略条目关联的前缀列表 ID。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeTransitRouterRoutePolicyEntries&Version=2020-04-01&TransitRouterRoutePolicyTableId=tr-rpt-hy13n2l4c6c0v**** HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250815T033712Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250815/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeTransitRouterRoutePolicyEntries",​
"Version": "2020-04-01",​
"Service": "transitrouter",​
"Region": "cn-beijing"​
},​
"Result": {​
"PageNumber": 1,​
"PageSize": 20,​
"TotalCount": 1,​
"TransitRouterRoutePolicyEntries": [​
{​
"IpPrefixMatchMode": "Complete",​
"TransitRouterRoutePolicyTableId": "tr-rpt-hy13n2l4c6c0v****",​
"TransitRouterRoutePolicyEntryId": "tr-rpe-13f1fdx5l****",​
"Description": "for test",​
"Status": "Available",​
"Priority": 100,​
"IpPrefixes": [​
"192.168.XX.XX/24"​
],​
"SourceResourceTypes": [​
"VPC"​
],​
"SourceResourceIds": [​
"vpc-bp1aevy8sofi8mh1****"​
],​
"DestinationResourceTypes": [​
"VPC"​
],​
"DestinationResourceIds": [​
"vpc-bp1aevy8sofi8mh1****"​
],​
"ActionResult": "Permit",​
"AsPathOperateMode": "Additive",​
"ApplyAsPathValues": [​
65001​
],​
"CreationTime": "2023-08-14T18:05:17+08:00",​
"UpdateTime": "2023-08-14T18:05:17+08:00"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
LimitExceeded.ResourceIds​
You've reached the limit of 100 resource IDs that can be specified in this request.​
该请求传入了非法或不支持的参数。资源查询数目最大限制100。​
​
​
最近更新时间:2026.03.24 10:26:55
这个页面对您有帮助吗?
有用
有用
无用
无用