You need to enable JavaScript to run this app.
导航

DescribeDirectConnectGatewayRoutes

最近更新时间2024.04.18 19:01:51

首次发布时间2022.03.25 07:38:20

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

调用说明

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

调试

请求参数

名称类型是否必选示例值描述
ActionStringDescribeDirectConnectGatewayRoutes要执行的操作,取值为DescribeDirectConnectGatewayRoutes。
VersionString2020-04-01API版本信息。

DirectConnectGatewayRouteIds.N

List of String

DirectConnectGatewayRouteIds.1= dcr-4jhsdn0nekil****&DirectConnectGatewayRouteIds.2=dcr-13fszmm1xdssg3n6nu4x9****

专线网关路由的ID。

  • 参数 - N:表示专线网关路由ID的序号,单次调用数量上限100个。
  • 多个专线网关路由ID之间用&分隔。
DirectConnectGatewayIdStringdcg-7qthudw0ll6jmc****专线网关的ID。您可调用DescribeDirectConnectGateways查询专线网关的ID。
DestinationCidrBlockString172.XX.XX.0/24专线网关路由的目的网段。
NextHopIdStringdcv-13fszmm1xdssg3n6nu4x9****专线网关路由的下一跳实例的ID。您可调用DescribeDirectConnectVirtualInterfaces查询下一跳为虚拟接口的实例ID。

NextHopType

String

VIF

专线网关路由的下一跳实例类型,取值如下:

  • VIF:虚拟接口
  • CEN:云企业网

RouteType

String

BGP

专线网关路由的类型,取值如下:

  • BGP:BGP动态路由
  • Static:静态路由
  • CEN:云企业网路由,即专线网关加入云企业网后,从云企业网同步的路由。

PageNumber

Integer

1

列表的页码。

  • 如需传入此参数,请传入非负整数。
  • 不传或传入0,则均默认为1。
PageSizeInteger20分页查询时每页的行数。最大值为100,默认值为20。

返回数据

名称类型
示例值
描述
RequestIdString20211222112033010224****请求ID。
TotalCountInteger10满足指定条件的专线网关路由总数。
PageNumberInteger1当前页码。
PageSizeInteger20当前分页的行数。
DirectConnectGatewayRoutesArray of struct-专线网关路由的详细信息。具体请参见下表“ DirectConnectGatewayRoute ”。

DirectConnectGatewayRoute

名称类型
示例值
描述
AccountIdString21000*****专线网关路由所属账号的ID。
DirectConnectGatewayIdStringdcg-7qthudw0ll6jmc****专线网关的ID。
DirectConnectGatewayRouteIdStringdcr-4jhsdn0nekil****专线网关路由的ID。
DestinationCidrBlockString172.XX.XX.0/24专线网关路由的目的网段。
NextHopIdStringdcv-13fszmm1xdssg3n6nu4x9****专线网关路由的下一跳实例的ID。

NextHopType

String

VIF

专线网关路由的下一跳实例类型。

  • VIF:虚拟接口
  • CEN:云企业网

RouteType

String

BGP

专线网关路由的类型。

  • BGP:BGP动态路由
  • Static:静态路由
  • CEN:云企业网路由
CreationTimeString2021-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
错误码
错误信息
描述
400LimitExceeded.DirectConnectGatewayRouteIdYou've reached the limit on the number of direct connect gateway route IDs that you can describe.已达到可查询的专线网关路由ID数量上限。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。