文档

ViewSmartAccessGatewayRoutes - 查看SAG设备路由详情

更新时间:

查看SAG设备路由详情,适用于设备类型为SCG5000或SCG5000-5G的智能接入网关实例,且设备版本为3.4.2及以上。

接口说明

目前仅设备版本为 3.4.2 及以上的 SCG5000 和 SCG5000-5G 设备支持查看智能接入网关设备路由详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:ViewSmartAccessGatewayRoutesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SagInsIdstring

智能接入网关实例 ID。

sag-sv487b7lno6go5****
SagSnstring

智能接入网关设备序列号。

sagf4ea****
RegionIdstring

智能接入网关实例所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
CrossAccountboolean

是否只查询跨账号所属的智能接入网关实例。取值:

  • false(默认值):否。

  • true:是。

false
ResourceUidstring

智能接入网关实例所属的阿里云账号(主账号)ID。

147304382796****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

F3D21D0B-5258-5412-AD1C-3929D297286B
Routesobject []

路由信息列表。

Idxinteger

接口编号。当取值为**-1**时表示下一跳指向 VPN 隧道。

取值范围:-1~4294967295

2
Typestring

路由类型。取值:

  • static:静态路由。

  • bgp:BGP 动态路由。

  • ospf:OSPF 动态路由。

static
Rolestring

端口角色。

WAN
Dststring

目标网段。

172.1.1.0/24
Nexthopstring

下一跳。

1.XX.XX.1
ConflictCidrsarray

冲突网段列表。

string

冲突网段。

192.XX.XX.0/24
Coststring

路由开销值。

第一个 0 表示:路由协议管理距离(AD)。

第二个 0 表示:度量值(metric)。

[0/0]

示例

正常返回示例

JSON格式

{
  "RequestId": "F3D21D0B-5258-5412-AD1C-3929D297286B",
  "Routes": [
    {
      "Idx": 2,
      "Type": "static",
      "Role": "WAN",
      "Dst": "172.1.1.0/24",
      "Nexthop": "1.XX.XX.1",
      "ConflictCidrs": [
        "192.XX.XX.0/24"
      ],
      "Cost": "[0/0]"
    }
  ]
}

错误码

HTTP status code错误码错误信息
400GATEWAY.InvalidSNThe specified gateway serial number does not exist.
400MissParameter.GatewayIdThe input parameter GatewayId that is mandatory for processing this model is not supplied.
400InvalidSpec.FeatureNotSupportThe current edition of the cloudbranch does not support this feature.

访问错误中心查看更多错误码。