Contact UsGet started

Cloud Interconnect API, gRPC: PrivateConnectionService.Get

Written by
Improved by
Updated at April 24, 2025

Returns the specified PrivateConnection resource.

To get the list of available PrivateConnection resources, make a List request.

gRPC request

rpc Get (GetPrivateConnectionRequest) returns (PrivateConnection)

GetPrivateConnectionRequest

{
  "private_connection_id": "string"
}

Field

Description

private_connection_id

string

Required field. ID of the PrivateConnection resource to return.
To get the privateConnection ID use a PrivateConnectionService.List request.

PrivateConnection

{
  "id": "string",
  "name": "string",
  "description": "string",
  "folder_id": "string",
  "region_id": "string",
  "trunk_connection_id": "string",
  "vlan_id": "google.protobuf.Int64Value",
  "ipv4_peering": {
    "peering_subnet": "string",
    "peer_ip": "string",
    "cloud_ip": "string",
    "peer_bgp_asn": "int64",
    "cloud_bgp_asn": "int64",
    "peer_bgp_md5_key": "string"
  },
  "ipv4_static_routes": [
    {
      "prefix": "string"
    }
  ],
  "labels": "map<string, string>",
  "status": "Status",
  "created_at": "google.protobuf.Timestamp"
}

A PrivateConnection resource.

Field

Description

id

string

ID of the privateConnection.

name

string

Name of the privateConnection.
The name must be unique within the folder.
Value must match the regular expression \\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Optional description of the privateConnection. 0-256 characters long.

folder_id

string

ID of the folder that the privateConnection belongs to.

region_id

string

ID of the region that the privateConnection belongs to.

trunk_connection_id

string

ID of the trunk_connection that the privateConnection belongs to.

vlan_id

google.protobuf.Int64Value

VLAN_ID that the privateConnection uses in multiplexing.
Not used in connections over partners-II
Value range: [1, 4095]

ipv4_peering

Peering

IPv4 peering config of connection

ipv4_static_routes[]

StaticRoute

IPv4 StaticRoute config of connection

labels

object (map<string, string>)

Resource labels, key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_0-9a-z]*.

status

enum Status

Status of the privateConnection.

  • STATUS_UNSPECIFIED
  • CREATING
  • UPDATING
  • DELETING
  • ACTIVE

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

Peering

Field

Description

peering_subnet

string

PeeringSubnet.
It's an ip with format ipPrefix/length where address part of ipPrefix is 0.

peer_ip

string

PeerIp.
It's an ip with just an ipAddress format without mask.

cloud_ip

string

CloudIp.
It's an ip with just an ipAddress format without mask.

peer_bgp_asn

int64

PeerBgpAsn.
PeerAsn excluding rfc5398 (excluding 64496 - 64511 and 65536 - 65551).

cloud_bgp_asn

int64

CloudBgpAsn.

peer_bgp_md5_key

string

PeerBgpMd5Key.
Optional.

StaticRoute

Field

Description

prefix

string

Prefix.
It's an ip with format ipPrefix/length where address part of ipPrefix is 0.
Previous
Overview
Next
List