Get Router Status
|
|||||
|
|
Retrieves runtime information of the specified router
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
Input
This building block consumes 3 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
region Required |
STRING |
Name of the region for this request |
router Required |
STRING |
Name of the Router resource to query |
= Parameter name
= Format
project STRING Required Project ID for this request |
region STRING Required Name of the region for this request |
router STRING Required Name of the Router resource to query |
Output
This building block provides 61 output parameters
Name | Format | Description |
---|---|---|
kind |
STRING |
Type of resource |
result |
OBJECT |
|
result.bestRoutes[] |
OBJECT |
Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) |
result.bestRoutes[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
result.bestRoutes[].description |
STRING |
An optional description of this resource. Provide this field when you create the resource |
result.bestRoutes[].destRange |
STRING |
The destination range of outgoing packets that this route applies to. Only IPv4 is supported |
result.bestRoutes[].id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
result.bestRoutes[].kind |
STRING |
[Output Only] Type of this resource. Always compute#routes for Route resources |
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 |
result.bestRoutes[].network |
STRING |
Fully-qualified URL of the network that this route applies to |
result.bestRoutes[].nextHopGateway |
STRING |
The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway |
result.bestRoutes[].nextHopInstance |
STRING |
The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ |
result.bestRoutes[].nextHopIp |
STRING |
The network IP address of an instance that should handle matching packets. Only IPv4 is supported |
result.bestRoutes[].nextHopNetwork |
STRING |
The URL of the local network if it should handle matching packets |
result.bestRoutes[].nextHopPeering |
STRING |
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035 |
result.bestRoutes[].nextHopVpnTunnel |
STRING |
The URL to a VpnTunnel that should handle matching packets |
result.bestRoutes[].priority |
INTEGER |
The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is |
result.bestRoutes[].selfLink |
STRING |
[Output Only] Server-defined fully-qualified URL for this resource |
result.bestRoutes[].tags[] |
STRING |
|
result.bestRoutes[].warnings[] |
OBJECT |
|
result.bestRoutes[].warnings[].code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
result.bestRoutes[].warnings[].message |
STRING |
[Output Only] A human-readable description of the warning code |
result.bestRoutesForRouter[] |
OBJECT |
Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) |
result.bestRoutesForRouter[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
result.bestRoutesForRouter[].description |
STRING |
An optional description of this resource. Provide this field when you create the resource |
result.bestRoutesForRouter[].destRange |
STRING |
The destination range of outgoing packets that this route applies to. Only IPv4 is supported |
result.bestRoutesForRouter[].id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
result.bestRoutesForRouter[].kind |
STRING |
[Output Only] Type of this resource. Always compute#routes for Route resources |
result.bestRoutesForRouter[].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 |
result.bestRoutesForRouter[].network |
STRING |
Fully-qualified URL of the network that this route applies to |
result.bestRoutesForRouter[].nextHopGateway |
STRING |
The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway |
result.bestRoutesForRouter[].nextHopInstance |
STRING |
The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ |
result.bestRoutesForRouter[].nextHopIp |
STRING |
The network IP address of an instance that should handle matching packets. Only IPv4 is supported |
result.bestRoutesForRouter[].nextHopNetwork |
STRING |
The URL of the local network if it should handle matching packets |
result.bestRoutesForRouter[].nextHopPeering |
STRING |
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035 |
result.bestRoutesForRouter[].nextHopVpnTunnel |
STRING |
The URL to a VpnTunnel that should handle matching packets |
result.bestRoutesForRouter[].priority |
INTEGER |
The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is |
result.bestRoutesForRouter[].selfLink |
STRING |
[Output Only] Server-defined fully-qualified URL for this resource |
result.bestRoutesForRouter[].tags[] |
STRING |
|
result.bestRoutesForRouter[].warnings[] |
OBJECT |
|
result.bestRoutesForRouter[].warnings[].code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
result.bestRoutesForRouter[].warnings[].message |
STRING |
[Output Only] A human-readable description of the warning code |
result.bgpPeerStatus[] |
OBJECT |
|
result.bgpPeerStatus[].advertisedRoutes[] |
OBJECT |
Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) |
result.bgpPeerStatus[].ipAddress |
STRING |
IP address of the local BGP interface |
result.bgpPeerStatus[].linkedVpnTunnel |
STRING |
URL of the VPN tunnel that this BGP peer controls |
result.bgpPeerStatus[].name |
STRING |
Name of this BGP peer. Unique within the Routers resource |
result.bgpPeerStatus[].numLearnedRoutes |
INTEGER |
Number of routes learned from the remote BGP Peer |
result.bgpPeerStatus[].peerIpAddress |
STRING |
IP address of the remote BGP interface |
result.bgpPeerStatus[].state |
STRING |
BGP state as specified in RFC1771 |
result.bgpPeerStatus[].status |
ENUMERATION |
Status of the BGP peer: {UP, DOWN} |
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.natStatus[] |
OBJECT |
Status of a NAT contained in this router. Next tag: 9 |
result.natStatus[].autoAllocatedNatIps[] |
STRING |
|
result.natStatus[].minExtraNatIpsNeeded |
INTEGER |
The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is not used |
result.natStatus[].name |
STRING |
Unique name of this NAT |
result.natStatus[].numVmEndpointsWithNatMappings |
INTEGER |
Number of VM endpoints (i.e., Nics) that can use NAT |
result.natStatus[].userAllocatedNatIpResources[] |
STRING |
|
result.natStatus[].userAllocatedNatIps[] |
STRING |
|
result.network |
STRING |
URI of the network to which this router belongs |
= Parameter name
= Format
kind STRING Type of resource |
result OBJECT |
result.bestRoutes[] OBJECT Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) |
result.bestRoutes[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
result.bestRoutes[].description STRING An optional description of this resource. Provide this field when you create the resource |
result.bestRoutes[].destRange STRING The destination range of outgoing packets that this route applies to. Only IPv4 is supported |
result.bestRoutes[].id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
result.bestRoutes[].kind STRING [Output Only] Type of this resource. Always compute#routes for Route resources |
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 |
result.bestRoutes[].network STRING Fully-qualified URL of the network that this route applies to |
result.bestRoutes[].nextHopGateway STRING The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway |
result.bestRoutes[].nextHopInstance STRING The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ |
result.bestRoutes[].nextHopIp STRING The network IP address of an instance that should handle matching packets. Only IPv4 is supported |
result.bestRoutes[].nextHopNetwork STRING The URL of the local network if it should handle matching packets |
result.bestRoutes[].nextHopPeering STRING [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035 |
result.bestRoutes[].nextHopVpnTunnel STRING The URL to a VpnTunnel that should handle matching packets |
result.bestRoutes[].priority INTEGER The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is |
result.bestRoutes[].selfLink STRING [Output Only] Server-defined fully-qualified URL for this resource |
result.bestRoutes[].tags[] STRING |
result.bestRoutes[].warnings[] OBJECT |
result.bestRoutes[].warnings[].code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
result.bestRoutes[].warnings[].message STRING [Output Only] A human-readable description of the warning code |
result.bestRoutesForRouter[] OBJECT Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) |
result.bestRoutesForRouter[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
result.bestRoutesForRouter[].description STRING An optional description of this resource. Provide this field when you create the resource |
result.bestRoutesForRouter[].destRange STRING The destination range of outgoing packets that this route applies to. Only IPv4 is supported |
result.bestRoutesForRouter[].id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
result.bestRoutesForRouter[].kind STRING [Output Only] Type of this resource. Always compute#routes for Route resources |
result.bestRoutesForRouter[].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 |
result.bestRoutesForRouter[].network STRING Fully-qualified URL of the network that this route applies to |
result.bestRoutesForRouter[].nextHopGateway STRING The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway |
result.bestRoutesForRouter[].nextHopInstance STRING The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ |
result.bestRoutesForRouter[].nextHopIp STRING The network IP address of an instance that should handle matching packets. Only IPv4 is supported |
result.bestRoutesForRouter[].nextHopNetwork STRING The URL of the local network if it should handle matching packets |
result.bestRoutesForRouter[].nextHopPeering STRING [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035 |
result.bestRoutesForRouter[].nextHopVpnTunnel STRING The URL to a VpnTunnel that should handle matching packets |
result.bestRoutesForRouter[].priority INTEGER The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is |
result.bestRoutesForRouter[].selfLink STRING [Output Only] Server-defined fully-qualified URL for this resource |
result.bestRoutesForRouter[].tags[] STRING |
result.bestRoutesForRouter[].warnings[] OBJECT |
result.bestRoutesForRouter[].warnings[].code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
result.bestRoutesForRouter[].warnings[].message STRING [Output Only] A human-readable description of the warning code |
result.bgpPeerStatus[] OBJECT |
result.bgpPeerStatus[].advertisedRoutes[] OBJECT Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) |
result.bgpPeerStatus[].ipAddress STRING IP address of the local BGP interface |
result.bgpPeerStatus[].linkedVpnTunnel STRING URL of the VPN tunnel that this BGP peer controls |
result.bgpPeerStatus[].name STRING Name of this BGP peer. Unique within the Routers resource |
result.bgpPeerStatus[].numLearnedRoutes INTEGER Number of routes learned from the remote BGP Peer |
result.bgpPeerStatus[].peerIpAddress STRING IP address of the remote BGP interface |
result.bgpPeerStatus[].state STRING BGP state as specified in RFC1771 |
result.bgpPeerStatus[].status ENUMERATION Status of the BGP peer: {UP, DOWN} |
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.natStatus[] OBJECT Status of a NAT contained in this router. Next tag: 9 |
result.natStatus[].autoAllocatedNatIps[] STRING |
result.natStatus[].minExtraNatIpsNeeded INTEGER The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is not used |
result.natStatus[].name STRING Unique name of this NAT |
result.natStatus[].numVmEndpointsWithNatMappings INTEGER Number of VM endpoints (i.e., Nics) that can use NAT |
result.natStatus[].userAllocatedNatIpResources[] STRING |
result.natStatus[].userAllocatedNatIps[] STRING |
result.network STRING URI of the network to which this router belongs |