Method: interconnects.getDiagnostics

Returns the interconnectDiagnostics for the specified interconnect.

HTTP request

GET https://www.googleapis.com/compute/v1/projects/{project}/global/interconnects/{resourceId}/getDiagnostics

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

resourceId

string

Name of the interconnect resource to query.

Request body

The request body must be empty.

Response body

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

Response for the InterconnectsGetDiagnosticsRequest.

JSON representation
{
  "result": {
    "macAddress": string,
    "arpCaches": [
      {
        "macAddress": string,
        "ipAddress": string
      }
    ],
    "links": [
      {
        "circuitId": string,
        "googleDemarc": string,
        "receivingOpticalPower": {
          "value": number,
          "state": enum
        },
        "transmittingOpticalPower": {
          "value": number,
          "state": enum
        },
        "lacpStatus": {
          "state": enum,
          "googleSystemId": string,
          "neighborSystemId": string
        },
        "arpCaches": [
          {
            "macAddress": string,
            "ipAddress": string
          }
        ]
      }
    ]
  }
}
Fields
result

object

result.macAddress

string

The MAC address of the Interconnect's bundle interface.

result.arpCaches[]

object

A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.

result.arpCaches[].macAddress

string

The MAC address of this ARP neighbor.

result.arpCaches[].ipAddress

string

The IP address of this ARP neighbor.

result.links[]

object

A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.

result.links[].circuitId

string

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

result.links[].googleDemarc

string

The Demarc address assigned by Google and provided in the LoA.

result.links[].receivingOpticalPower

object

result.links[].receivingOpticalPower.value

number

Value of the current optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.

result.links[].receivingOpticalPower.state

enum

result.links[].transmittingOpticalPower

object

result.links[].transmittingOpticalPower.value

number

Value of the current optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.

result.links[].transmittingOpticalPower.state

enum

result.links[].lacpStatus

object

result.links[].lacpStatus.state

enum

result.links[].lacpStatus.googleSystemId

string

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

result.links[].lacpStatus.neighborSystemId

string

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

result.links[].arpCaches[]

object

A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled

result.links[].arpCaches[].macAddress

string

The MAC address of this ARP neighbor.

result.links[].arpCaches[].ipAddress

string

The IP address of this ARP neighbor.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.interconnects.get
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine