文档首页/ 云专线 DC/ API参考 (联盟区域) / API/ 全域接入网关路由表/ 查询全域接入网关路由表
更新时间：2026-01-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询全域接入网关路由表

功能介绍

查询全域接入网关路由表

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/dcaas/gdgw/{gdgw_id}/routetables

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

最小长度：0

最大长度：36

gdgw_id

是

String

全域接入网关ID
表2 Query参数

参数

是否必选

参数类型

描述

fields

否

Array of strings

显示字段列表

数组长度：1 - 5

ext_fields

否

Array of strings

show response ext-fields

数组长度：0 - 5

limit

否

Integer

每页返回的个数。

取值范围：1~2000。

最小值：1

最大值：2000

缺省值：2000

marker

否

String

上一页最后一条资源记录的ID，为空时为查询第一页。

使用说明：必须与limit一起使用。

最小长度：0

最大长度：36

nexthop

否

Array of strings

下一条ID

destination

否

Array of strings

目的地址

address_family

否

Array of strings

地址簇

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：0

最大长度：10240

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求id

最小长度：0

最大长度：36

gdgw_routetables

Array of CommonRoutetable objects

全域接入网关路由表

数组长度：0 - 2000

total_count

Integer

总记录数

page_info

PageInfo object

分页查询页的信息
表5 CommonRoutetable

参数

参数类型

描述

id

String

路由id

最小长度：36

最大长度：36

tenant_id

String

租户id

最小长度：64

最大长度：64

gateway_id

String

网关id

最小长度：36

最大长度：36

destination

String

路由子网

最小长度：64

最大长度：64

nexthop

String

下一跳id

最小长度：36

最大长度：36

obtain_mode

String

路由类型:

  • customized: 默认路由

  • specific: 自定义路由

  • bgp: 动态路由

status

String

路由状态:

  • ACTIVE: 下发正常

  • ERROR: 下发失败

  • PENDING_CREATE: 待下发

address_family

String

地址族类型:

  • ipv4: ipv4

  • ipv6: ipv6

description

String

路由描述

最小长度：0

最大长度：1024

type

String

下一跳类型:

  • vif_peer: 虚拟接口对等体

  • gdgw: 全域接入网关

最小长度：0

最大长度：255
表6 PageInfo

参数

参数类型

描述

previous_marker

String

上一页的marker，值为资源的uuid

最小长度：0

最大长度：36

current_count

Integer

当前列表中资源数量

最小值：0

最大值：2000

next_marker

String

下一页的marker，值为资源的uuid，为空时表示最后一页

最小长度：0

最大长度：36

请求示例

查询全域接入网关路由表

GET https://{dc_endpoint}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/gdgw/0851a5e0-6623-42c2-bb02-b8956e313dd8/routetables

响应示例

状态码：200

OK

查询全域接入网关路由表响应体

{
  "request_id" : "409ed40b-7ccf-4514-8ca8-af2b994e4023",
  "gdgw_routetables" : [ {
    "id" : "14d55a22-9d08-46af-bc2e-f965f9558234",
    "description" : "v4子网路由",
    "tenant_id" : "00000000000000000000000000000000",
    "gateway_id" : "5791e3c8-b43d-4751-bfeb-a643e40e6086",
    "destination" : "x.x.0.0/16",
    "nexthop" : "409ed40b-7ccf-4514-8ca8-af2b994e4023",
    "type" : "vif_peer",
    "obtain_mode" : "customized",
    "status" : "ACTIVE",
    "address_family" : "ipv4"
  } ],
  "total_count" : 1,
  "page_info" : {
    "previous_marker" : "54bf7a78-1a7d-4d42-ac07-abb2f903f2c1",
    "current_count" : 1
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。