You need to enable JavaScript to run this app.
导航
DescribeTransitRouterRoutePolicyEntries
最近更新时间:2024.07.09 08:42:35首次发布时间:2024.03.26 10:24:48

调用DescribeTransitRouterRoutePolicyEntries接口,查询满足指定条件的路由策略条目。

说明

路由策略功能正在邀测中,如需调用该接口,请联系客户经理。

调试

请求参数

名称类型是否必选示例值描述
ActionStringDescribeTransitRouterRoutePolicyEntries要执行的操作,取值为DescribeTransitRouterRoutePolicyEntries。
VersionString2020-04-01API版本信息,当前版本为2020-04-01。
PageSizeInteger20分页查询时每页的行数,取值范围为1 ~ 100,默认值为20。
PageNumberInteger1列表的页码,默认值为1。
TransitRouterRoutePolicyTableIdStringtr-rpt-hy13n2l4c6c0v****路由策略的ID。您可以调用DescribeTransitRouterRoutePolicyTables接口获取路由策略的ID。
TransitRouterRoutePolicyEntryIds.NStringtr-rpe-13f1fdx5l****路由策略条目的ID。

Direction

String

In

路由策略的作用方向。取值如下:

  • In:收方向。指中转路由器从网络实例学习路由时,只接收符合路由策略的路由。
  • Out:发方向。指中转路由器向网络实例同步路由时,只发送符合路由策略的路由。

返回参数

名称类型示例值描述
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger3符合条件的路由策略条目的总数。
TransitRouterRoutePolicyEntriesArray of Struct-符合条件的转发策略条目的详细信息。具体请参见下表“ TransitRouterRoutePolicyEntries ”。

TransitRouterRoutePolicyEntries

名称类型示例值描述
TransitRouterRoutePolicyTableIdStringtr-rpt-hy13n2l4c6c0v****路由策略的ID。
TransitRouterRoutePolicyEntryIdStringtr-rpe-13f1fdx5l****路由策略条目的ID。
DescriptionStringfor test路由策略条目的描述信息。

Status

String

Available

路由策略条目的状态。

  • Creating: 创建中。
  • Deleting: 删除中。
  • Pending:配置中。
  • Available:可用。
PriorityInteger100路由策略条目的优先级,数字越小优先级越高。
IpPrefixesList of String["192.168.XX.XX/24", "172.16.XX.XX/24"]路由策略条目的路由前缀。

SourceResourceTypes

List of String

["VPC", "DirectConnectGateway"]

路由策略条目的源实例类型。

  • VPC:私有网络。
  • DirectConnectGateway:专线网关。
  • TransitRouter:跨地域TR。
SourceResourceIdsList of String["vpc-bp1aevy8sofi8mh1****", "dcg-3tex2x1cwd4c6c0v****"]路由策略条目的源实例ID。

DestinationResourceTypes

List of String

["VPC", "DirectConnectGateway"]

路由策略条目的目的实例类型。

  • VPC:私有网络。
  • DirectConnectGateway:专线网关。
  • TransitRouter:跨地域TR。
DestinationResourceIdsList of String["vpc-bp1aevy8sofi8mh1****", "dcg-3tex2x1cwd4c6c0v****"]路由策略条目的目的实例ID。

ActionResult

String

Permit

路由策略条目的策略行为。

  • Permit:允许。指允许匹配该路由策略条目的路由通过。
  • Deny:拒绝。指拒绝匹配该路由策略条目的路由通过。

AsPathOperateMode

String

Additive

路由策略条目的AsPath设置方式。

  • Additive:追加AsPath。指在允许通过的路由的AsPath最前面追加指定的AsPath。
  • Replace:替换AsPath。指使用指定的AsPath替换允许通过的路由的AsPath。
ApplyAsPathValuesList of Integer[65001, 65002]路由策略条目设置的路由AsPath。
CreationTimeString2023-08-14T18:05:17+08:00路由策略条目的创建时间。
UpdateTimeString2023-08-14T18:05:17+08:00路由策略条目的更新时间。

请求示例

GET /?Action=DescribeTransitRouterRoutePolicyEntries&Version=2020-04-01&TransitRouterRoutePolicyTableId=tr-rpt-hy13n2l4c6c0v**** HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeTransitRouterRoutePolicyEntries",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "TransitRouterRoutePolicyEntries": [
            {
                "TransitRouterRoutePolicyEntryId": "tr-rtpe-imbz0gmfhnuo8gbssykd****",
                "TransitRouterRoutePolicyTableId": "tr-rtp-2fe8qx7hpxfk059gp68tn****",
                "Description": "",
                "CreationTime": "2024-03-08T11:11:15+08:00",
                "UpdateTime": "2024-03-08T11:11:15+08:00",
                "Status": "Available",
                "Priority": 12,
                "ActionResult": "Permit",
                "IpPrefixes": [
                    "192.XX.XX.0/24"
                ],
                "SourceResourceTypes": [
                    "VPC"
                ],
                "SourceResourceIds": [],
                "DestinationResourceTypes": [],
                "DestinationResourceIds": [],
                "AsPathOperateMode": "Additive",
                "ApplyAsPathValues": [
                    111,
                    222
                ]
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.ResourceIdsYou've reached the limit of 100 resource IDs that can be specified in this request.该请求传入了非法或不支持的参数。资源查询数目最大限制100。