Contact UsGet started

Cloud Router API, gRPC: RoutingInstanceService.GetByVpcNetworkId

Written by
Updated at April 24, 2025

Returns the RoutingInstance resource by vpcNetworkId

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

gRPC request

rpc GetByVpcNetworkId (GetRoutingInstanceByVpcNetworkIdRequest) returns (RoutingInstance)

GetRoutingInstanceByVpcNetworkIdRequest

{
  "vpc_network_id": "string"
}

Field

Description

vpc_network_id

string

Required field. ID of the VpcNetwork resource to return by.
To get the routingInstance ID use a RoutingInstanceService.List request.

RoutingInstance

{
  "id": "string",
  "name": "string",
  "description": "string",
  "folder_id": "string",
  "region_id": "string",
  "vpc_info": [
    {
      "vpc_network_id": "string",
      "az_infos": [
        {
          "manual_info": {
            "az_id": "string",
            "prefixes": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "cic_private_connection_info": [
    {
      "cic_private_connection_id": "string"
    }
  ],
  "status": "Status",
  "created_at": "google.protobuf.Timestamp",
  "labels": "map<string, string>"
}

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.

folder_id

string

ID of the folder that the routingInstance belongs to.

region_id

string

ID of the region that the routingInstance belongs to.

vpc_info[]

VpcInfo

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

cic_private_connection_info[]

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

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

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

vpc_network_id

string

ID of the vpcNetwork that is attached to the routingInstance.

az_infos[]

VpcAzInfo

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

VpcAzInfo

Field

Description

manual_info

VpcManualInfo

VpcInfo which is set by user

VpcManualInfo

Field

Description

az_id

string

ID of the AZ

prefixes[]

string

List of prefixes to announce

CicPrivateConnectionInfo

Field

Description

cic_private_connection_id

string

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