全部产品
Search

搜索本产品

    智能接入网关：ViewSmartAccessGatewayPortRouteProtocol - 获取SAG设备路由协议开启的端口列表

    文档中心

    智能接入网关：ViewSmartAccessGatewayPortRouteProtocol - 获取SAG设备路由协议开启的端口列表

    更新时间：Mar 29, 2024

    获取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:ViewSmartAccessGatewayPortRouteProtocolRead
    • 全部资源
      *
      无
    		无

    请求参数

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

    智能接入网关实例 ID。

    		sag-sv487b7lno6go5****
    SagSnstring是

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

    		sagf4dk****
    RegionIdstring是

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

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

    		cn-shanghai
    CrossAccountboolean否

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

    • false（默认值）：否。

    • true：是。

    		false
    ResourceUidstring否

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

    		109790620697****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		877F5673-FFD1-5168-99D1-1E8009FBFF7B
    Portsobject []

    端口信息列表。

    Statusstring

    端口状态。取值：

    • UP：端口开启。
    • DOWN：端口关闭。
    		UP
    RemoteIpstring

    对端 IP 地址。

    		192.XX.XX.1
    PortNamestring

    端口名称。

    		5
    NeighborIpstring

    邻居 IP 地址。

    		192.XX.XX.2
    RouteProtocolstring

    端口路由协议。取值：

    • STATIC：静态路由协议。
    • OSPF：OSPF 动态路由协议。
    • BGP：BGP 动态路由协议。
    		BGP
    RemoteAsstring

    对端 BGP 自治系统编号。

    		65535
    Vlanstring

    VLAN 编号。

    		2
    TaskStatesobject []

    查询任务信息状态。

    ErrorMessagestring

    错误信息。Successful 标识查询任务成功。

    		Successful
    Statestring

    异步任务状态：

    • Initialized：查询任务初始化。
    • Offline：智能接入网关设备离线未下发查询任务，智能接入网关设备上线后会继续下发。
    • Succeed：查询任务下发成功。
    • Processing：查询任务下发中。
    • VersionNotSupport：智能接入网关设备当前版本不支持。
    • BuildRequestError：管控不支持。
    • HardwareError：由于设备原因查询任务下发失败。
    • TaskNotExist：查询任务不存在。
    • OfflineNotConfiged：智能接入网关设备离线未下发查询任务，智能接入网关设备上线后也不会下发。
    		Succeed
    ErrorCodestring

    错误码。200 标识查询任务成功。

    		200
    CreateTimestring

    查询任务创建时间戳。

    时间戳的格式采用 Unix 时间戳，表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至创建查询任务时的总时长。

    		1586765938000

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "877F5673-FFD1-5168-99D1-1E8009FBFF7B",
  "Ports": [
    {
      "Status": "UP",
      "RemoteIp": "192.XX.XX.1",
      "PortName": "5",
      "NeighborIp": "192.XX.XX.2",
      "RouteProtocol": "BGP",
      "RemoteAs": "65535",
      "Vlan": "2"
    }
  ],
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586765938000"
    }
  ]
}

    错误码

    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.

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