Cloud Router API, gRPC: RoutingInstanceService.GetByVpcNetworkId
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. The maximum string length in characters is 50. |
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",
"deletion_protection": "bool",
"created_at": "google.protobuf.Timestamp",
"labels": "map<string, string>"
}
|
Field |
Description |
|
id |
string ID of the routingInstance. |
|
name |
string Name of the routingInstance. |
|
description |
string 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[] |
List of the info about vpcNetworks which are attached to routingInstance. |
|
cic_private_connection_info[] |
List of the info about privateConnections which are attached to routingInstance. |
|
status |
enum Status Status of the routingInstance.
|
|
deletion_protection |
bool |
|
created_at |
Creation timestamp in RFC3339 text format. |
|
labels |
object (map<string, string>) Resource labels, |
VpcInfo
|
Field |
Description |
|
vpc_network_id |
string Required field. ID of the vpcNetwork that is attached to the routingInstance. The maximum string length in characters is 50. |
|
az_infos[] |
List of the az-related info about vpcNetworks which are attached to routingInstance The number of elements must be in the range 0-50. |
VpcAzInfo
|
Field |
Description |
|
manual_info |
Required field. VpcInfo which is set by user |
VpcManualInfo
|
Field |
Description |
|
az_id |
string Required field. ID of the AZ The maximum string length in characters is 50. |
|
prefixes[] |
string List of prefixes to announce The number of elements must be in the range 0-10000. |
CicPrivateConnectionInfo
|
Field |
Description |
|
cic_private_connection_id |
string Required field. ID of the cicPrivateConnection that is attached to the routingInstance. The maximum string length in characters is 50. |