Method: projects.locations.zones.networks.diagnose

Get the diagnostics of a single network resource.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the network resource.

Request body

The request body must be empty.

Response body

DiagnoseNetworkResponse contains the current status for a specific network.

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

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

string (Timestamp format)

The time when the network status 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 (NetworkStatus)

The network status of a specific network.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

NetworkStatus

NetworkStatus has a list of status for the subnets under the current network.

JSON representation 
{
  "subnetStatus": [
    {
      object (SubnetStatus)
    }
  ],
  "macsecStatusInternalLinks": enum (MacsecStatus)
}
Fields
subnetStatus[]

object (SubnetStatus)

A list of status for the subnets under the current network.

SubnetStatus

SubnetStatus contains detailed and current technical information about this subnet resource.

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

string

The name of CCFE subnet resource.
macAddress

string

BVI MAC address.

MacsecStatus

Denotes the status of MACsec sessions for the links of a zone.

Enums
MACSEC_STATUS_UNSPECIFIED MACsec status not specified, likely due to missing metrics.
SECURE All relevant links have at least one MACsec session up.
UNSECURE At least one relevant link does not have any MACsec sessions up.