Get

Returns the specified interconnect

2 variables
33 variables

Returns the specified interconnect. Get a list of available interconnects by making a list() request

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 2 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

interconnect STRING Required

Name of the interconnect to return

Output

This building block provides 33 output parameters

  = Parameter name
  = Format

adminEnabled BOOLEAN

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true

circuitInfos[] OBJECT

Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4

circuitInfos[].customerDemarcId STRING

Customer-side demarc ID for this circuit

circuitInfos[].googleCircuitId STRING

Google-assigned unique ID for this circuit. Assigned at circuit turn-up

circuitInfos[].googleDemarcId STRING

Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

customerName STRING

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect

description STRING

An optional description of this resource. Provide this property when you create the resource

expectedOutages[] OBJECT

Description of a planned outage on this Interconnect. Next id: 9

expectedOutages[].affectedCircuits[] STRING

expectedOutages[].description STRING

A description about the purpose of the outage

expectedOutages[].endTime INTEGER

Scheduled end time for the outage (milliseconds since Unix epoch)

expectedOutages[].issueType ENUMERATION

Form this outage is expected to take, which can take one of the following values:

  • OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
  • PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.

expectedOutages[].name STRING

Unique identifier for this outage notification

expectedOutages[].source ENUMERATION

The party that generated this notification, which can take the following value:

  • GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.

expectedOutages[].startTime INTEGER

Scheduled start time for the outage (milliseconds since Unix epoch)

expectedOutages[].state ENUMERATION

State of this notification, which can take one of the following values:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.

googleIpAddress STRING

[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests

googleReferenceId STRING

[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues

id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

interconnectAttachments[] STRING

interconnectType ENUMERATION

Type of interconnect, which can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

kind STRING

[Output Only] Type of the resource. Always compute#interconnect for interconnects

linkType ENUMERATION

Type of link requested, which can take one of the following values:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

location STRING

URL of the InterconnectLocation object that represents where this connection is to be provisioned

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

nocContactEmail STRING

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications

operationalStatus ENUMERATION

[Output Only] The current status of this Interconnect's functionality, which can take one of the following values:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.

peerIpAddress STRING

[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests

provisionedLinkCount INTEGER

[Output Only] Number of links actually provisioned in this interconnect

requestedLinkCount INTEGER

Target number of physical links in the link bundle, as requested by the customer

selfLink STRING

[Output Only] Server-defined URL for the resource

state ENUMERATION

[Output Only] The current state of Interconnect functionality, which can take one of the following values:

  • ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
  • UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
  • UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.