Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Cloud Interconnect API, gRPC: TrunkConnectionService.Get

Written by
Updated at December 17, 2024

Returns the specified TrunkConnection resource.

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

gRPC request

rpc Get (GetTrunkConnectionRequest) returns (TrunkConnection)

GetTrunkConnectionRequest

{
  "trunk_connection_id": "string"
}

Field

Description

trunk_connection_id

string

Required field. ID of the TrunkConnection resource to return.
To get the trunkConnection ID use a TrunkConnectionService.List request.

TrunkConnection

{
  "id": "string",
  "name": "string",
  "description": "string",
  "folder_id": "string",
  "region_id": "string",
  // Includes only one of the fields `single_port_direct_joint`, `lag_direct_joint`, `partner_joint_info`
  "single_port_direct_joint": {
    "transceiver_type": "TransceiverType",
    "port_name": "google.protobuf.StringValue",
    "access_device_name": "string"
  },
  "lag_direct_joint": {
    "transceiver_type": "TransceiverType",
    "lag_allocation_settings": {
      "lag_info": {
        "lag_id": "google.protobuf.Int64Value",
        "port_names": [
          "string"
        ]
      }
    },
    "access_device_name": "string"
  },
  "partner_joint_info": {
    "service_key": "string",
    "partner_id": "google.protobuf.StringValue"
  },
  // end of the list of possible fields
  "point_of_presence_id": "google.protobuf.StringValue",
  "capacity": "Capacity",
  "labels": "map<string, string>"
}

A TrunkConnection resource.

Field

Description

id

string

ID of the trunkConnection.

name

string

Name of the trunkConnection.
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 trunkConnection. 0-256 characters long.

folder_id

string

ID of the folder that the trunkConnection belongs to.

region_id

string

ID of the region that the trunkConnection belongs to.

single_port_direct_joint

SinglePortDirectJoint

Includes only one of the fields single_port_direct_joint, lag_direct_joint, partner_joint_info.

Special trunkConnection config

lag_direct_joint

LagDirectJoint

Includes only one of the fields single_port_direct_joint, lag_direct_joint, partner_joint_info.

Special trunkConnection config

partner_joint_info

PartnerJointInfo

Includes only one of the fields single_port_direct_joint, lag_direct_joint, partner_joint_info.

Special trunkConnection config

point_of_presence_id

google.protobuf.StringValue

ID of pointOfPresence that the trunkConnection is deployed on.
Optional.
If is not set scheduler selects it by himself.

capacity

enum Capacity

Capacity of the trunkConnection

  • CAPACITY_UNSPECIFIED
  • CAPACITY_50_MBPS
  • CAPACITY_100_MBPS
  • CAPACITY_200_MBPS
  • CAPACITY_300_MBPS
  • CAPACITY_400_MBPS
  • CAPACITY_500_MBPS
  • CAPACITY_1_GBPS
  • CAPACITY_2_GBPS
  • CAPACITY_3_GBPS
  • CAPACITY_4_GBPS
  • CAPACITY_5_GBPS
  • CAPACITY_10_GBPS
  • CAPACITY_20_GBPS
  • CAPACITY_30_GBPS
  • CAPACITY_40_GBPS
  • CAPACITY_50_GBPS
  • CAPACITY_100_GBPS

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]*.

SinglePortDirectJoint

Config of trunkConnection that is deployed on single port.

Field

Description

transceiver_type

enum TransceiverType

Type of transceiver that the trunkConnection is deployed on.

  • TRANSCEIVER_TYPE_UNSPECIFIED
  • TRANSCEIVER_TYPE_1000BASE_LX
  • TRANSCEIVER_TYPE_10GBASE_LR
  • TRANSCEIVER_TYPE_10GBASE_ER
  • TRANSCEIVER_TYPE_100GBASE_LR4
  • TRANSCEIVER_TYPE_100GBASE_ER4

port_name

google.protobuf.StringValue

Name of port that the trunkConnection is deployed on.

access_device_name

string

Device name which is set in LLDP message.

LagDirectJoint

Config of trunkConnection that is deployed on lag.

Field

Description

transceiver_type

enum TransceiverType

Type of transceiver that the trunkConnection is deployed on.

  • TRANSCEIVER_TYPE_UNSPECIFIED
  • TRANSCEIVER_TYPE_1000BASE_LX
  • TRANSCEIVER_TYPE_10GBASE_LR
  • TRANSCEIVER_TYPE_10GBASE_ER
  • TRANSCEIVER_TYPE_100GBASE_LR4
  • TRANSCEIVER_TYPE_100GBASE_ER4

lag_allocation_settings

LagAllocationSettings

LAG allocation settings that the trunkConnection is deployed on.

access_device_name

string

Device name which is set in LLDP message.

LagAllocationSettings

Structure that describes LAG allocation settings

Field

Description

lag_info

LagInfo

LagInfo

LagInfo

Field

Description

lag_id

google.protobuf.Int64Value

ID of LAG.
Optional.
If is not set scheduler selects it by himself.

port_names[]

string

List of port names that the LAG is deployed on.

PartnerJointInfo

Config of trunkConnection that is deployed on partner joint.

Field

Description

service_key

string

Reserved for future using;

partner_id

google.protobuf.StringValue

ID of partner that the trunkConnection is deployed on.
Optional.
If is not set scheduler selects it by himself.
Previous
Overview
Next
List