Method: wireGroups.get

Gets the specified wire group resource in the given scope.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
crossSiteNetwork

string
wireGroup

string

Name of the wire group resource to return.

Request body

The request body must be empty.

Response body

A resource that represents a group of redundant wires.

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

JSON representation 
{
  "kind": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "endpoints": {
    string: {
      "interconnects": {
        string: {
          "interconnect": string,
          "vlanTags": [
            integer
          ]
        },
        ...
      }
    },
    ...
  },
  "wireGroupProperties": {
    "type": enum
  },
  "wireProperties": {
    "bandwidthUnmetered": string,
    "faultResponse": enum
  },
  "adminEnabled": boolean,
  "wires": [
    {
      "label": string,
      "endpoints": [
        {
          "interconnect": string,
          "vlanTag": integer
        }
      ],
      "wireProperties": {
        "bandwidthUnmetered": string,
        "faultResponse": enum
      },
      "adminEnabled": boolean
    }
  ],
  "topology": {
    "endpoints": [
      {
        "label": string,
        "city": string
      }
    ]
  }
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#wireGroups for wire groups.
id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
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.
description

string

An optional description of the wire group.
endpoints[]

map (key: string, value: object)

A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows:

  • Key: an RFC1035 user-specified label.
  • Value: an Endpoint object.
endpoints[].interconnects[]

map (key: string, value: object)

A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows:

  • Key: an RFC1035 user-specified label.
  • Value: an Interconnect object.
endpoints[].interconnects[].interconnect

string

An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs:

endpoints[].interconnects[].vlanTags[]

integer

To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from 2 to 4093. You can autoallocate a tag by entering 0. To configure the wire group for port mode, enter -1. Review the following guidelines:

  • A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups.
  • Both endpoints of a wire must use the same VLAN tag value.
  • Single wire and redundant type wire groups must have only one VLAN tag.
  • Port mode pseudowires must have a single VLAN tag with a value of -1 for both endpoints.
  • Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire.
wireGroupProperties

object

Properties of the wire group.
wireGroupProperties.type

enum

The type of the wire group, one of the following:

  • WIRE: a single pseudowire over two Interconnect connections with no redundancy.
  • REDUNDANT: two pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Each pseudowire connects Interconnect connections in matching edge availability domains of the two metros.
  • BOX_AND_CROSS: four pseudowires over four Interconnect connections, with two connections in one metro and two connections in another metro. Each redundant pair of Interconnect connections spans both edge availability domains of the metro. Two pseudowires connect Interconnect connections in matching edge availability domains of the two metros. Two additional pseudowires connect the non-matching edge availability domains of the two metros.
wireProperties

object

Properties for all wires in the wire group.
wireProperties.bandwidthUnmetered

string (int64 format)

The unmetered bandwidth in Gigabits per second, using decimal units. 10 is 10 Gbps, 100 is 100 Gbps.
wireProperties.faultResponse

enum

Response when a fault is detected in a pseudowire:

  • NONE: default.
  • DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
adminEnabled

boolean

Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of adminEnabled to false, a given wire is enabled. Defaults to true.
wires[]

object

The single/redundant wire(s) managed by the wire group.
wires[].label

string

[Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1, where:

  • ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects.
  • CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects.
wires[].endpoints[]

object

Wire endpoints are specific Interconnect connections.
wires[].endpoints[].interconnect

string
wires[].endpoints[].vlanTag

integer
wires[].wireProperties

object

[Output Only] Properties of the wire.
wires[].wireProperties.bandwidthUnmetered

string (int64 format)

The unmetered bandwidth in Gigabits per second, using decimal units. 10 is 10 Gbps, 100 is 100 Gbps.
wires[].wireProperties.faultResponse

enum

Response when a fault is detected in a pseudowire:

  • NONE: default.
  • DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.
wires[].adminEnabled

boolean

[Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
topology

object

Topology details for the wire group configuration.
topology.endpoints[]

object

Topology details for all endpoints in the wire group.
topology.endpoints[].label

string

Endpoint label from the wire group.
topology.endpoints[].city

string

The InterconnectLocation.city (metropolitan area designator) that all interconnects are located in.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • 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 IAM permissions:

  • compute.wireGroups.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.