Cloud Interconnect API, REST: TrunkConnection.List

Статья создана

Yandex Cloud

Улучшена

Tania L.

Обновлена 24 апреля 2025 г.

HTTP request
Query parameters
Response
TrunkConnection
SinglePortDirectJoint
LagDirectJoint
LagAllocationSettings
LagInfo
PartnerJointInfo

Retrieves the list of TrunkConnection resources in the specified folder.

HTTP request

GET https://cic.api.cloud.yandex.net/cic/v1/trunkConnections

Query parameters

Field	Description
folderId	string Required field. ID of the folder to list TrunkConnection resources. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.
pageSize	string (int64) The maximum number of results per page to return. If the number of available results is larger than `pageSize`, the service returns a ListTrunkConnectionsResponse.nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100.
pageToken	string Page token. To get the next page of results, set `pageToken` to the ListTrunkConnectionsResponse.nextPageToken returned by a previous list request.
filter	string A filter expression that filters resources listed in the response. The expression must specify: The field name. Currently you can use filtering only on [Subnet.name] field. An `=` operator. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`.

Response

HTTP Code: 200 - OK

{
  "trunkConnections": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "folderId": "string",
      "regionId": "string",
      "createdAt": "string",
      // Includes only one of the fields `singlePortDirectJoint`, `lagDirectJoint`, `partnerJointInfo`
      "singlePortDirectJoint": {
        "transceiverType": "string",
        "portName": "string",
        "accessDeviceName": "string"
      },
      "lagDirectJoint": {
        "transceiverType": "string",
        "lagAllocationSettings": {
          "lagInfo": {
            "lagId": "string",
            "portNames": [
              "string"
            ]
          }
        },
        "accessDeviceName": "string"
      },
      "partnerJointInfo": {
        "serviceKey": "string",
        "partnerId": "string"
      },
      // end of the list of possible fields
      "pointOfPresenceId": "string",
      "capacity": "string",
      "labels": "object",
      "status": "string",
      "deletionProtection": "boolean"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

trunkConnections[]

TrunkConnection

List of TrunkConnection resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListTrunkConnectionsRequest.pageSize, use
the nextPageToken as the value
for the ListTrunkConnectionsRequest.pageToken query parameter
in the next list request. Subsequent list requests will have their own
nextPageToken to continue paging through the results.

TrunkConnection

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.
folderId	string ID of the folder that the trunkConnection belongs to.
regionId	string ID of the region that the trunkConnection belongs to.
createdAt	string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
singlePortDirectJoint	SinglePortDirectJoint Includes only one of the fields `singlePortDirectJoint`, `lagDirectJoint`, `partnerJointInfo`. Special trunkConnection config
lagDirectJoint	LagDirectJoint Includes only one of the fields `singlePortDirectJoint`, `lagDirectJoint`, `partnerJointInfo`. Special trunkConnection config
partnerJointInfo	PartnerJointInfo Includes only one of the fields `singlePortDirectJoint`, `lagDirectJoint`, `partnerJointInfo`. Special trunkConnection config
pointOfPresenceId	string 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` `CAPACITY_200_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]`.
status	enum (Status) Status of the trunkConnection. `STATUS_UNSPECIFIED` `CREATING` `UPDATING` `DELETING` `ACTIVE`
deletionProtection	boolean Optional deletion protection flag. If set prohibits deletion of the trunkConnection.

SinglePortDirectJoint

Config of trunkConnection that is deployed on single port.

Field	Description
transceiverType	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`
portName	string Name of port that the trunkConnection is deployed on.
accessDeviceName	string Device name which is set in LLDP message.

LagDirectJoint

Config of trunkConnection that is deployed on lag.

Field	Description
transceiverType	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`
lagAllocationSettings	LagAllocationSettings LAG allocation settings that the trunkConnection is deployed on.
accessDeviceName	string Device name which is set in LLDP message.

LagAllocationSettings

Structure that describes LAG allocation settings

Field

Description

lagInfo

LagInfo

LagInfo

Field

Description

lagId

string (int64)

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

portNames[]

string

List of port names that the LAG is deployed on.

PartnerJointInfo

Config of trunkConnection that is deployed on partner joint.

Field

Description

serviceKey

string

Reserved for future using;

partnerId

string

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

Cloud Interconnect API, REST: TrunkConnection.List

HTTP requestHTTP request

Query parametersQuery parameters

ResponseResponse

TrunkConnectionTrunkConnection

SinglePortDirectJointSinglePortDirectJoint

LagDirectJointLagDirectJoint

LagAllocationSettingsLagAllocationSettings

LagInfoLagInfo

PartnerJointInfoPartnerJointInfo

Была ли статья полезна?

HTTP request

Query parameters

Response

TrunkConnection

SinglePortDirectJoint

LagDirectJoint

LagAllocationSettings

LagInfo

PartnerJointInfo