Contact UsGet started

Cloud Router API, REST: RoutingInstance.List

Written by
Updated at February 21, 2025

Retrieves the list of RoutingInstance resources in the specified folder.

HTTP request

GET https://cloudrouter.api.cloud.yandex.net/cloudrouter/v1/routingInstances

Query parameters

Field

Description

folderId

string

Required field. ID of the folder to list RoutingInstance 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 ListRoutingInstancesResponse.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
[ListRoutingInstanceResponse.next_page_token] returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can use filtering only on RoutingInstance.name field.
  2. An = operator.
  3. 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

{
  "routingInstances": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "folderId": "string",
      "regionId": "string",
      "vpcInfo": [
        {
          "vpcNetworkId": "string",
          "azInfos": [
            {
              "manualInfo": {
                "azId": "string",
                "prefixes": [
                  "string"
                ]
              }
            }
          ]
        }
      ],
      "cicPrivateConnectionInfo": [
        {
          "cicPrivateConnectionId": "string"
        }
      ],
      "status": "string",
      "createdAt": "string",
      "labels": "object"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

routingInstances[]

RoutingInstance

List of RoutingInstance 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 [ListRoutingInstancesResponse.page_size], use
the nextPageToken as the value
for the [ListRoutingInstanceResponses.page_token] query parameter
in the next list request. Subsequent list requests will have their own
nextPageToken to continue paging through the results.

RoutingInstance

Field

Description

id

string

ID of the routingInstance.

name

string

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

folderId

string

ID of the folder that the routingInstance belongs to.

regionId

string

ID of the region that the routingInstance belongs to.

vpcInfo[]

VpcInfo

List of the info about vpcNetworks which are attached to routingInstance.

cicPrivateConnectionInfo[]

CicPrivateConnectionInfo

List of the info about privateConnections which are attached to routingInstance.

status

enum (Status)

Status of the routingInstance.

  • STATUS_UNSPECIFIED
  • CREATING
  • UPDATING
  • DELETING
  • ACTIVE

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).

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

VpcInfo

Field

Description

vpcNetworkId

string

ID of the vpcNetwork that is attached to the routingInstance.

azInfos[]

VpcAzInfo

List of the az-related info about vpcNetworks which are attached to routingInstance

VpcAzInfo

Field

Description

manualInfo

VpcManualInfo

VpcInfo which is set by user

VpcManualInfo

Field

Description

azId

string

ID of the AZ

prefixes[]

string

List of prefixes to announce

CicPrivateConnectionInfo

Field

Description

cicPrivateConnectionId

string

ID of the cicPrivateConnection that is attached to the routingInstance.
Previous
Get
Next
Create