Method: routers.getRouterStatus

Retrieves runtime information of the specified router.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/routers/{resourceId}/getRouterStatus

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region for this request.

resourceId

string

Name of the Router resource to query.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "result": {
    "network": string,
    "bestRoutes": {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "network": string,
      "tags": [
        string
      ],
      "destRange": string,
      "priority": number,
      "nextHopInstance": string,
      "nextHopIp": string,
      "nextHopNetwork": string,
      "nextHopGateway": string,
      "nextHopPeering": string,
      "warnings": [
        {
          "code": enum,
          "message": string,
          "data": {
            "key": string,
            "value": string
          }
        }
      ],
      "nextHopVpnTunnel": string,
      "selfLink": string,
      "kind": string
    },
    "bestRoutesForRouter": {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "network": string,
      "tags": [
        string
      ],
      "destRange": string,
      "priority": number,
      "nextHopInstance": string,
      "nextHopIp": string,
      "nextHopNetwork": string,
      "nextHopGateway": string,
      "nextHopPeering": string,
      "warnings": [
        {
          "code": enum,
          "message": string,
          "data": {
            "key": string,
            "value": string
          }
        }
      ],
      "nextHopVpnTunnel": string,
      "selfLink": string,
      "kind": string
    },
    "bgpPeerStatus": {
      "name": string,
      "linkedVpnTunnel": string,
      "ipAddress": string,
      "peerIpAddress": string,
      "status": enum,
      "state": string,
      "uptime": string,
      "uptimeSeconds": string,
      "numLearnedRoutes": number,
      "advertisedRoutes": [
        {
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "network": string,
          "tags": string,
          "destRange": string,
          "priority": number,
          "nextHopInstance": string,
          "nextHopIp": string,
          "nextHopNetwork": string,
          "nextHopGateway": string,
          "nextHopPeering": string,
          "warnings": {
            "code": enum,
            "message": string,
            "data": [
              {
                "key": string,
                "value": string
              }
            ]
          },
          "nextHopVpnTunnel": string,
          "selfLink": string,
          "kind": string
        }
      ]
    }
  },
  "kind": string,
}
Fields
result

object

result.network

string

URI of the network to which this router belongs.

result.bestRoutes[]

object

Best routes for this router's network.

result.bestRoutes[].id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

result.bestRoutes[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

result.bestRoutes[].name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

result.bestRoutes[].description

string

An optional description of this resource. Provide this property when you create the resource.

result.bestRoutes[].network

string

Fully-q