Skip to main content
ZStack
Resource Center/Network Resource/OSPF Operations

GetVRouterOspfNeighbor

GetVRouterOspfNeighbor

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

Operation ID

GetVRouterOspfNeighbor

Since

3.4.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • vRouterUuid
    StringRequired

    The vRouter UUID.

Query Parameters

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • neighbors
    ListRequired

    See neighbors.

    • id
      StringRequired

      The resource ID.

    • priority
      StringRequired

      The priority.

    • state
      StringRequired

      The resource state.

    • deadTime
      StringRequired

      The dead time.

    • neighborAddress
      StringRequired

      The neighbor address.

    • device
      StringRequired

      The device.