DescribeTransitRouterRoutePolicyTables--中转路由器-火山引擎

文档中心

立即注册

导航

DescribeTransitRouterRoutePolicyTables

最近更新时间：2024.09.24 10:51:23首次发布时间：2024.03.26 10:24:48

调用DescribeTransitRouterRoutePolicyTables接口，查询满足指定条件的路由策略。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTransitRouterRoutePolicyTables	要执行的操作，取值为DescribeTransitRouterRoutePolicyTables。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。
PageNumber	Integer	否	1	列表的页码，默认值为1。
TransitRouterId	String	是	tr-7qthudw0ll6jmc****	中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。
TransitRouterRoutePolicyTableName	String	否	tr-routepolicy-for-rtb1	路由策略的名称。
TransitRouterRoutePolicyTableIds.N	String	否	TransitRouterRoutePolicyTableIds.1=tr-rpt-hy13n2l4c6c0v**&TransitRouterRoutePolicyTableIds.2=tr-rpt-hy13n2l4c6c0v**	路由策略的ID。 N：表示路由策略的序号，取值范围为1～100。多个路由策略ID之间使用&分隔。
Direction	String	否	In	路由策略的方向。取值如下： In：收方向。指中转路由器从网络实例学习路由时，只接收符合路由策略的路由。 Out：发方向。指中转路由器向网络实例同步路由时，只发送符合路由策略的路由。

返回参数

名称	类型	示例值	描述
PageSize	Integer	20	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	2	符合条件的路由策略的总数。
TransitRouterRoutePolicyTables	Array of Struct	-	符合条件的路由策略的详细信息。具体请参见下表“ TransitRouterRoutePolicyTables ”。

TransitRouterRoutePolicyTables

名称	类型	示例值	描述
TransitRouterRoutePolicyTableId	String	tr-fpt-hy13n2l4c6c0v****	路由策略的ID。
TransitRouterRoutePolicyTableName	String	tr-routepolicy-for-rtb1	路由策略的名称。
TransitRouterId	String	tr-7qthudw0ll6jmc****	路由策略所属中转路由器实例的ID。
Description	String	This route table is used for tests.	路由策略的描述信息。
Status	String	Available	路由策略的状态。 Creating: 创建中。 Deleting: 删除中。 Pending：配置中。 Available：可用。
Direction	String	In	路由策略的作用方向。
CreationTime	String	2021-04-09T08:36:47+08:00	路由策略的创建时间。
UpdateTime	String	2021-04-10T09:18:28+08:00	路由策略的最近操作时间。
TransitRouterRouteTableIds	List of String	["tr-rtb-hy13n2l4c6c0v**", "tr-rtb-im8p5z1v7rb48g**"]	路由策略绑定的TR路由表ID。

请求示例

GET /?Action=DescribeTransitRouterRoutePolicyTables&Version=2020-04-01& HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240308112229220E9CC293E6E1D0B236",
        "Action": "DescribeTransitRouterRoutePolicyTables",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "TransitRouterRoutePolicyTables": [
            {
                "TransitRouterRoutePolicyTableId": "tr-rtp-2fe8qx7hpxfk059gp68tnbjky",
                "TransitRouterRoutePolicyTableName": "hyh",
                "TransitRouterId": "tr-12b5kn2ko629s17q7y2bahlu6",
                "Description": "",
                "CreationTime": "2024-03-08T11:11:13+08:00",
                "UpdateTime": "2024-03-08T11:11:13+08:00",
                "Status": "Available",
                "Direction": "In",
                "TransitRouterRouteTableIds": [
                    "tr-rtb-hy13n2l4c6c0v****",
                    "tr-rtb-im8p5z1v7rb48g****"
                ]
            }
        ]
    }

错误码

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

HttpCode	错误码	错误信息	描述
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。