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

文档中心

立即注册

导航

DescribeTransitRouterRouteEntries

最近更新时间：2024.11.27 17:29:27首次发布时间：2023.03.07 09:56:38

调用DescribeTransitRouterRouteEntries接口，查询满足指定条件的路由条目。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTransitRouterRouteEntries	要执行的操作，取值为DescribeTransitRouterRouteEntries。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TransitRouterRouteTableId	String	是	tr-rtb-hy13n2l4c6c0v****	中转路由器实例关联的路由表的ID。您可以调用DescribeTransitRouterRouteTables接口获取TR路由表的ID。
DestinationCidrBlock	String	否	192.168.XX.XX/24	路由条目的目标网段。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。
Status	String	否	Available	路由条目的状态。 Available：可用。 Creating：创建中。 Pending：配置中。 Deleting：删除中。 Conflicted：未生效。
TransitRouterRouteEntryName	String	否	entry01	路由条目的名称。
TransitRouterRouteEntryType	String	否	Static	路由条目的类型。 Static：静态路由。 Propagated：自动学习路由。
TransitRouterRouteEntryIds.N	String	否	TransitRouterRouteEntryIds.1=tr-rte-1i5i8khf9m58gae5kcx6**&TransitRouterRouteEntryIds.2=tr-rte-12ghy8jkmg**	TR路由条目的ID。 N：表示TR路由条目的序号，取值范围为1～100。多个TR路由条目ID之间使用&分隔。

返回参数

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

TransitRouterRouteEntries

名称	类型	示例值	描述
Description	String	This is a sample description.	路由条目的描述信息。
DestinationCidrBlock	String	192.168.XX.XX/24	路由条目的目标网段。
Status	String	Available	路由条目的状态。 Available：可用。 Creating：创建中。 Pending：配置中。 Deleting：删除中。 Conflicted：未生效。
TransitRouterRouteEntryId	String	tr-rte-12ghy8jkmg****	路由条目的ID。
TransitRouterRouteEntryName	String	trentry01	路由条目的名称。
TransitRouterRouteEntryNextHopType	String	Attachment	路由条目的下一跳类型。 Attachment：网络实例，表示匹配该路由条目的流量会被转发到指定的网络实例。 BlackHole：黑洞，表示匹配该路由条目的流量会被丢弃。
TransitRouterRouteEntryNextHopId	String	tr-attach-vx6iwhjr1x****	路由条目的下一跳ID。参数`TransitRouterRouteEntryNextHopType`为“Attachment”时，该参数生效。
TransitRouterRouteEntryType	String	Static	路由条目的类型。 Static：静态路由。 Propagated：学习路由。
AsPath	List of String	["20314","23141"]	路由条目的AS路径。
CreationTime	String	2021-04-09T08:36:47+08:00	路由条目的创建时间。
UpdateTime	String	2021-04-09T08:36:47+08:00	路由条目的的最近操作时间。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeTransitRouterRouteEntries",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageSize": 20,
        "PageNumber": 1,
        "TotalCount": 1,
        "TransitRouterRouteEntries": [
            {   
                "TransitRouterRouteEntryName": "trentry01",
                "TransitRouterRouteEntryId": "tr-rte-12ghy8jkmg****",
                "DestinationCidrBlock": "192.168.XX.XX/24",
                "Description": "This is a sample description.",
                "TransitRouterRouteEntryType": "Static",
                "TransitRouterRouteEntryNextHopType": "Attachment",
                "TransitRouterRouteEntryNextHopId": "vpc-bp1aevy8sofi8mh1****",
                "TransitRouterRouteTableId": "tr-rtb-hy13n2l4c6c0v****",
                "AsPath": [],
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Status": "Available"
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。