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

文档中心

立即注册

导航

DescribeTransitRouterForwardPolicyEntries

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

调用DescribeTransitRouterForwardPolicyEntries接口，查询满足指定条件的转发策略条目。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTransitRouterForwardPolicyEntries	要执行的操作，取值为DescribeTransitRouterForwardPolicyEntries。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TransitRouterForwardPolicyTableId	String	是	tr-fpt-hy13n2l4c6c0v****	转发策略的ID。您可以调用DescribeTransitRouterForwardPolicyTables接口获取转发策略的ID。
TransitRouterRouteTableId	String	否	tr-rtb-hy13n2l4c6c0v****	转发策略条目的转发路由表ID。您可以调用DescribeTransitRouterRouteTables接口获取TR路由表的ID。
TransitRouterForwardPolicyEntryIds.N	String	否	TransitRouterForwardPolicyEntryIds.1=tr-fpe-1i5i8khf9m58gae5kcx6**&TransitRouterForwardPolicyEntryIds.2=tr-fpe-h5r2kwfmedg3e7aehk2**	转发策略条目的ID。
SourceCidrBlock	String	否	192.168.XX.XX/24	转发策略条目的源地址段。当前仅支持IPv4网段。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。

返回参数

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

TransitRouterForwardPolicyEntries

名称	类型	示例值	描述
Description	String	This is a sample description.	转发策略条目的描述信息。
SourceCidrBlock	String	192.168.XX.XX/24	转发策略条目的源地址段。
Status	String	Available	转发策略条目的状态。 Available：可用。 Creating：创建中。 Pending：配置中。 Deleting：删除中。 Conflicted：冲突。
TransitRouterForwardPolicyTableId	String	tr-fpt-hrgyyj6jmty****	转发策略的ID。
TransitRouterForwardPolicyEntryId	String	tr-fpe-12ghy8jkmg****	转发策略条目的ID。
Priority	Integer	100	转发策略条目的优先级。
TransitRouterRouteTableId	String	tr-rtb-35r03ksl3qpds1vfuib55****	转发路由表的ID。
CreationTime	String	2021-04-09T08:36:47+08:00	转发策略条目的创建时间。
UpdateTime	String	2021-04-09T08:36:47+08:00	转发策略条目的的最近操作时间。

请求示例

GET /?Action=DescribeTransitRouterForwardPolicyEntries&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": "DescribeTransitRouterForwardPolicyEntries",
        "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": [
                    "20314",
                    "23141"
                ],
                "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.	指定的分页参数不合法。
400	LimitExceeded.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	该请求传入了非法或不支持的参数。资源查询数目最大限制100。