Cloud Interconnect API, gRPC: TrunkConnectionService.BatchGet
gRPC request
rpc BatchGet (BatchGetTrunkConnectionsRequest) returns (BatchGetTrunkConnectionsResponse)
BatchGetTrunkConnectionsRequest
{
"trunk_connection_ids": [
"string"
]
}
|
Field |
Description |
|
trunk_connection_ids[] |
string IDs of TrunkConnection resources to return. The maximum string length in characters for each value is 1000. |
BatchGetTrunkConnectionsResponse
{
"trunk_connections": [
{
"id": "string",
"name": "string",
"description": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
// 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": {
"port_names": [
"string"
]
}
},
"access_device_name": "string"
},
"partner_joint_info": {
"partner_id": "google.protobuf.StringValue",
"service_key": "string"
},
// end of the list of possible fields
"point_of_presence_id": "google.protobuf.StringValue",
"capacity": "Capacity",
"labels": "map<string, string>",
"status": "Status",
"deletion_protection": "bool"
}
]
}
|
Field |
Description |
|
trunk_connections[] |
List of TrunkConnection resources. |
TrunkConnection
A TrunkConnection resource.
|
Field |
Description |
|
|
id |
string ID of the trunkConnection. |
|
|
name |
string Name of the trunkConnection. |
a-zA-Z?``. |
|
description |
string Optional description of the trunkConnection. 0-256 characters long. |
|
|
folder_id |
string ID of the folder that the trunkConnection belongs to. |
|
|
created_at |
Creation timestamp in RFC3339 text format. |
|
|
single_port_direct_joint |
Includes only one of the fields Special trunkConnection config |
|
|
lag_direct_joint |
Includes only one of the fields Special trunkConnection config |
|
|
partner_joint_info |
Includes only one of the fields Special trunkConnection config |
|
|
point_of_presence_id |
ID of pointOfPresence that the trunkConnection is deployed on. |
|
|
capacity |
enum Capacity Capacity of the trunkConnection
|
|
|
labels |
object (map<string, string>) Resource labels, |
|
|
status |
enum Status Status of the trunkConnection.
|
|
|
deletion_protection |
bool Deletion protection flag. |
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.
|
|
port_name |
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.
|
|
lag_allocation_settings |
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
|
Field |
Description |
|
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 |
|
partner_id |
ID of partner that the trunkConnection is deployed on. |
|
service_key |
string Reserved for future using; |