跳转到主要内容
ZStack
资源中心/网络资源/OSPF相关接口

获取OSPF的邻居信息

获取OSPF的邻居信息

GET/zstack/v1/routerArea/{vRouterUuid}/neighbor

操作 ID

GetVRouterOspfNeighbor

起始版本

3.4.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • vRouterUuid
    String必填

    路由器的uuid，唯一标识

查询参数

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • neighbors
    List必填

    详情参考neighbors

    • id
      String必填

      资源ID。

    • priority
      String必填

      优先级。

    • state
      String必填

      当前状态。

    • deadTime
      String必填

      死信时间。

    • neighborAddress
      String必填

      neighbor地址。

    • device
      String必填

      设备。