Method: projects.locations.zones.routers.diagnose

Get the diagnostics of a single router resource.

HTTP request

GET https://edgenetwork.googleapis.com/v1/{name=projects/*/locations/*/zones/*/routers/*}:diagnose

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the router resource.

Request body

The request body must be empty.

Response body

DiagnoseRouterResponse contains the current status for a specific router.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "updateTime": string,
  "result": {
    object (RouterStatus)
  }
}
Fields
updateTime

string (Timestamp format)

The time when the router status was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
result

object (RouterStatus)

The network status of a specific router.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

RouterStatus

Describing the current status of a router.

JSON representation 
{
  "network": string,
  "bgpPeerStatus": [
    {
      object (BgpPeerStatus)
    }
  ]
}
Fields
network

string

The canonical name of the network to which this router belongs.
bgpPeerStatus[]

object (BgpPeerStatus)

A list of BgpPeerStatus objects, describing all BGP peers related to this router.

BgpPeerStatus

Status of a BGP peer.

JSON representation 
{
  "name": string,
  "ipAddress": string,
  "peerIpAddress": string,
  "status": enum (BgpStatus),
  "state": string,
  "uptime": string,
  "uptimeSeconds": string,
  "prefixCounter": {
    object (PrefixCounter)
  }
}
Fields
name

string

Name of this BGP peer. Unique within the Routers resource.
ipAddress

string

IP address of the local BGP interface.
peerIpAddress

string

IP address of the remote BGP interface.
status

enum (BgpStatus)

The current status of BGP.
state

string

BGP state as specified in RFC1771.
uptime

string

Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
uptimeSeconds

string (int64 format)

Time this session has been up, in seconds.
prefixCounter

object (PrefixCounter)

A collection of counts for prefixes.

BgpStatus

Status of the BGP peer: {UP, DOWN}

Enums
UNKNOWN The default status indicating BGP session is in unknown state.
UP The UP status indicating BGP session is established.
DOWN The DOWN state indicating BGP session is not established yet.

PrefixCounter

PrefixCounter contains a collection of prefixes related counts.

JSON representation 
{
  "advertised": string,
  "denied": string,
  "received": string,
  "sent": string,
  "suppressed": string,
  "withdrawn": string
}
Fields
advertised

string (int64 format)

Number of prefixes advertised.
denied

string (int64 format)

Number of prefixes denied.
received

string (int64 format)

Number of prefixes received.
sent

string (int64 format)

Number of prefixes sent.
suppressed

string (int64 format)

Number of prefixes suppressed.
withdrawn

string (int64 format)

Number of prefixes withdrawn.