Routers: getRouterStatus

Requires authorization

Retrieves runtime information of the specified router.


HTTP request



Parameter name Value Description
Path parameters
project string Project ID for this request.
region string Name of the region for this request.
router string Name of the Router resource to query.


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "compute#routerStatusResponse",
  "result": {
    "network": string,
    "bestRoutes": [
      routes Resource
    "bestRoutesForRouter": [
      routes Resource
    "bgpPeerStatus": [
        "name": string,
        "linkedVpnTunnel": string,
        "ipAddress": string,
        "peerIpAddress": string,
        "status": string,
        "state": string,
        "uptime": string,
        "uptimeSeconds": string,
        "numLearnedRoutes": unsigned integer,
        "advertisedRoutes": [
          routes Resource
Property name Value Description Notes
kind string Type of resource.
result nested object string URI of the network to which this router belongs.
result.bestRoutes[] list Best routes for this router's network.
result.bgpPeerStatus[] list
result.bgpPeerStatus[].name string Name of this BGP peer. Unique within the Routers resource.
result.bgpPeerStatus[].linkedVpnTunnel string URL of the VPN tunnel that this BGP peer controls.
result.bgpPeerStatus[].ipAddress string IP address of the local BGP interface.
result.bgpPeerStatus[].peerIpAddress string IP address of the remote BGP interface.
result.bgpPeerStatus[].status string Status of the BGP peer: {UP, DOWN}
result.bgpPeerStatus[].state string BGP state as specified in RFC1771.
result.bgpPeerStatus[].uptime string Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
result.bgpPeerStatus[].uptimeSeconds string Time this session has been up, in seconds. Format: 145
result.bgpPeerStatus[].numLearnedRoutes unsigned integer Number of routes learned from the remote BGP Peer.
result.bgpPeerStatus[].advertisedRoutes[] list Routes that were advertised to the remote BGP peer
result.bestRoutesForRouter[] list Best routes learned by this router.

Send feedback about...

Compute Engine