DescribeDirectConnectGatewayRoutes--专线连接-火山引擎

文档中心

立即注册

导航

DescribeDirectConnectGatewayRoutes

最近更新时间：2024.10.30 17:04:54首次发布时间：2022.03.25 07:38:20

调用DescribeDirectConnectGatewayRoutes接口，查询符合要求的专线网关路由的详细信息。

调用说明

若请求参数不传入DirectConnectGatewayRouteIds，则会按照传入的其他参数查询，返回符合条件的专线网关路由。
若请求参数中的非必选参数都不传入，则会按照当前登录账户查询，返回当前账户下所有的专线网关路由。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDirectConnectGatewayRoutes	要执行的操作，取值为DescribeDirectConnectGatewayRoutes。
Version	String	是	2020-04-01	API版本信息。
DirectConnectGatewayRouteIds.N	List of String	否	DirectConnectGatewayRouteIds.1= dcr-4jhsdn0nekil**&DirectConnectGatewayRouteIds.2=dcr-13fszmm1xdssg3n6nu4x9**	专线网关路由的ID。参数 - N：表示专线网关路由ID的序号，单次调用数量上限100个。多个专线网关路由ID之间用&分隔。
DirectConnectGatewayId	String	否	dcg-7qthudw0ll6jmc****	专线网关的ID。您可调用DescribeDirectConnectGateways查询专线网关的ID。
DestinationCidrBlock	String	否	172.XX.XX.0/24	专线网关路由的目的网段。
NextHopId	String	否	dcv-13fszmm1xdssg3n6nu4x9****	专线网关路由的下一跳实例的ID。您可调用DescribeDirectConnectVirtualInterfaces查询下一跳为虚拟接口的实例ID。
NextHopType	String	否	VIF	专线网关路由的下一跳实例类型，取值如下： VIF：虚拟接口 CEN：云企业网 TransitRouter：中转路由器
RouteType	String	否	BGP	专线网关路由的类型，取值如下： BGP：BGP动态路由 Static：静态路由 CEN：云企业网路由，即专线网关加入云企业网后，从云企业网同步的路由。
PageNumber	Integer	否	1	列表的页码。如需传入此参数，请传入非负整数。不传或传入0，则均默认为1。
PageSize	Integer	否	20	分页查询时每页的行数。最大值为100，默认值为20。

返回数据

名称	类型	示例值	描述
RequestId	String	20211222112033010224****	请求ID。
TotalCount	Integer	10	满足指定条件的专线网关路由总数。
PageNumber	Integer	1	当前页码。
PageSize	Integer	20	当前分页的行数。
DirectConnectGatewayRoutes	Array of struct	-	专线网关路由的详细信息。具体请参见下表“ DirectConnectGatewayRoute ”。

DirectConnectGatewayRoute

名称	类型	示例值	描述
AccountId	String	21000*****	专线网关路由所属账号的ID。
DirectConnectGatewayId	String	dcg-7qthudw0ll6jmc****	专线网关的ID。
DirectConnectGatewayRouteId	String	dcr-4jhsdn0nekil****	专线网关路由的ID。
DestinationCidrBlock	String	172.XX.XX.0/24	专线网关路由的目的网段。
NextHopId	String	dcv-13fszmm1xdssg3n6nu4x9****	专线网关路由的下一跳实例的ID。
NextHopType	String	VIF	专线网关路由的下一跳实例类型。 VIF：虚拟接口 CEN：云企业网
RouteType	String	BGP	专线网关路由的类型。 BGP：BGP动态路由 Static：静态路由 CEN：云企业网路由
CreationTime	String	2021-04-09T08:36:47+08:00	创建专线网关路由的时间。
Status	String	Available	专线网关路由的状态。 Creating: 创建中 Deleting: 删除中 Pending：配置中 Available：可用

请求示例

GET /?Action=DescribeDirectConnectGatewayRoutes&Version=2020-04-01&DirectConnectGatewayIds.1=dcg-7qthudw0ll6jmc****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211222112033010224****",
        "Action": "DescribeDirectConnectGatewayRoutes",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20211222112033010224****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "DirectConnectGatewayRoutes": [
            {
                "AccountId":"210000****",
                "DirectConnectGatewayId": "dcg-7qthudw0ll6jmc****",
                "DirectConnectGatewayRouteId": "dcr-4jhsdn0nekil****",
                "DestinationCidrBlock":"172.XX.XX.0/24",
                "NextHopId":"dcv-13fszmm1xdssg3n6nu4x9****",
                "NextHopType":"VIF",
                "RouteType":"BGP",
                "CreationTime": "2021-12-15T17:05:42+08:00",
                "Status": "Available"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	LimitExceeded.DirectConnectGatewayRouteId	You've reached the limit on the number of direct connect gateway route IDs that you can describe.	已达到可查询的专线网关路由ID数量上限。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。