Method: projects.locations.zones.interconnects.diagnose

Get the diagnostics of a single interconnect resource.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the interconnect resource.

Request body

The request body must be empty.

Response body

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

DiagnoseInterconnectResponse contains the current diagnostics for a specific interconnect.

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

string (Timestamp format)

The time when the interconnect diagnostics was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
result

object (InterconnectDiagnostics)

The network status of a specific interconnect.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

InterconnectDiagnostics

Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection.

JSON representation 
{
  "macAddress": string,
  "linkLayerAddresses": [
    {
      object (LinkLayerAddress)
    }
  ],
  "links": [
    {
      object (LinkStatus)
    }
  ]
}
Fields
macAddress

string

The MAC address of the Interconnect's bundle interface.

LinkStatus

Describing the status for each link on the Interconnect.

JSON representation 
{
  "circuitId": string,
  "lacpStatus": {
    object (LinkLACPStatus)
  },
  "lldpStatuses": [
    {
      object (LinkLLDPStatus)
    }
  ],
  "packetCounts": {
    object (PacketCounts)
  }
}
Fields
circuitId

string

The unique ID for this link assigned during turn up by Google.
lacpStatus

object (LinkLACPStatus)

Describing the state of a LACP link.
lldpStatuses[]

object (LinkLLDPStatus)

A list of LinkLLDPStatus objects, used to describe LLDP status of each peer for each link on the Interconnect.
packetCounts

object (PacketCounts)

Packet counts specific statistics for this link.

LinkLACPStatus

Describing the status of a LACP link.

JSON representation 
{
  "state": enum (State),
  "googleSystemId": string,
  "neighborSystemId": string,
  "aggregatable": boolean,
  "collecting": boolean,
  "distributing": boolean
}
Fields
state

enum (State)

The state of a LACP link.
googleSystemId

string

System ID of the port on Google's side of the LACP exchange.
neighborSystemId

string

System ID of the port on the neighbor's side of the LACP exchange.
aggregatable

boolean

A true value indicates that the participant will allow the link to be used as part of the aggregate. A false value indicates the link should be used as an individual link.
collecting

boolean

If true, the participant is collecting incoming frames on the link, otherwise false
distributing

boolean

When true, the participant is distributing outgoing frames; when false, distribution is disabled

State

State enum for LACP link.

Enums
UNKNOWN The default state indicating state is in unknown state.
ACTIVE The link is configured and active within the bundle.
DETACHED The link is not configured within the bundle, this means the rest of the object should be empty.

LinkLLDPStatus

Describing a LLDP link.

JSON representation 
{
  "peerSystemName": string,
  "peerSystemDescription": string,
  "peerChassisId": string,
  "peerChassisIdType": string,
  "peerPortId": string,
  "peerPortIdType": string
}
Fields
peerSystemName

string

The peer system's administratively assigned name.
peerSystemDescription

string

The textual description of the network entity of LLDP peer.
peerChassisId

string

The peer chassis component of the endpoint identifier associated with the transmitting LLDP agent.
peerChassisIdType

string

The format and source of the peer chassis identifier string.
peerPortId

string

The port component of the endpoint identifier associated with the transmitting LLDP agent. If the specified port is an IEEE 802.3 Repeater port, then this TLV is optional.
peerPortIdType

string

The format and source of the peer port identifier string.

PacketCounts

Containing a collection of interface-related statistics objects.

JSON representation 
{
  "inboundUnicast": string,
  "inboundErrors": string,
  "inboundDiscards": string,
  "outboundUnicast": string,
  "outboundErrors": string,
  "outboundDiscards": string
}
Fields
inboundUnicast

string (int64 format)

The number of packets that are delivered.
inboundErrors

string (int64 format)

The number of inbound packets that contained errors.
inboundDiscards

string (int64 format)

The number of inbound packets that were chosen to be discarded even though no errors had been detected to prevent their being deliverable.
outboundUnicast

string (int64 format)

The total number of packets that are requested be transmitted.
outboundErrors

string (int64 format)

The number of outbound packets that could not be transmitted because of errors.
outboundDiscards

string (int64 format)

The number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being transmitted.