Getting information about a routing instance
Note
You need the cloud-router.viewer role for this operation.
You can view information about a routing instance using the following commands:
- yc cloudrouter routing-instance get: Allows you to get information about a routing instance using its name or ID.
- yc cloudrouter routing-instance get-by-cic-private-connection-id: Allows you to get information about a routing instance using the ID of the Yandex Cloud Interconnect private connection to the routing instance.
- yc cloudrouter routing-instance get-by-vpc-network-id: Allows you to get information about a routing instance using the ID of the cloud network the routing instance ensures connectivity with.
yc cloudrouter routing-instance get
-
See the description of the CLI command to get routing instance information:
yc cloudrouter routing-instance get --help -
Get the list of routing instances in the specified folder:
yc cloudrouter routing-instance list \ --folder-id <folder_ID>Result:
+----------------------+--------------------+--------+-----------------------+ | ID | NAME | STATUS | PRIVATE CONNECTION ID | +----------------------+--------------------+--------+-----------------------+ | cf3jqdc4gjpx******** | routing-instance | ACTIVE | euuiog88zphg********, | | | | | euucr7p47329******** | +----------------------+--------------------+--------+-----------------------+ -
Get information about a routing instance by providing its ID obtained in the previous step:
yc cloudrouter routing-instance get cf3jqdc4gjpx********Result:
Where:
id: Routing instance ID.name: RI name.description: RI description.folder_id: ID of the cloud folder the RI was created in.region_id: ID of the region the RI was created in.vpc_info: Information about virtual networks and their IP prefixes with the prefixes grouped by availability zone. A routing instance may have one or more connected virtual networks.cic_private_connection_info: Information about private connections to the RI.status: RI state. It may take the following values:ACTIVE: RI is active.CREATING: RI is being created.UPDATING: RI is being updated.DELETING: RI is being deleted.
yc cloudrouter routing-instance get-by-cic-private-connection-id
-
See the description of the CLI command to get routing instance information:
yc cloudrouter routing-instance get-by-cic-private-connection-id --help -
Get the list of private connections in the specified folder:
yc cic private-connection list \ --folder-id <folder_ID>Result:
+----------------------+------+----------------------+ | ID | NAME | TRUNK CONNECTION ID | +----------------------+------+----------------------+ | cf3r5ke20fo0******** | | cf3dcodot14p******** | | cf3r3mfr4bm5******** | | cf3dcodot14p******** | +----------------------+------+----------------------+ -
Get information about a routing instance by providing the ID of the private connection made to it:
yc cloudrouter routing-instance get-by-cic-private-connection-id \ --cic-prc-id cf3r5ke20fo0********Result:
Where:
id: Routing instance ID.name: RI name.description: RI description.folder_id: ID of the cloud folder the RI was created in.region_id: ID of the region the RI was created in.vpc_info: Information about virtual networks and their IP prefixes with the prefixes grouped by availability zone. A routing instance may have one or more connected virtual networks.cic_private_connection_info: Information about private connections to the RI.status: RI state. It may take the following values:ACTIVE: RI is active.CREATING: RI is being created.UPDATING: RI is being updated.DELETING: RI is being deleted.
yc cloudrouter routing-instance get-by-vpc-network-id
-
See the description of the CLI command to get routing instance information:
yc cloudrouter routing-instance get-by-vpc-network-id --help -
Get the list of cloud networks in the specified folder:
yc vpc network list \ --folder-id <folder_ID>Result:
+----------------------+-------------+ | ID | NAME | +----------------------+-------------+ | enpcfncr6uld******** | my-network1 | | enpcuntrql7d******** | my-network2 | +----------------------+-------------+ -
Get information about a routing instance by providing the ID of the cloud network the it ensures connectivity with:
yc cloudrouter routing-instance get-by-vpc-network-id \ --vpc-id enpcfncr6uld********Result:
Where:
id: Routing instance ID.name: RI name.description: RI description.folder_id: ID of the cloud folder the RI was created in.region_id: ID of the region the RI was created in.vpc_info: Information about virtual networks and their IP prefixes with the prefixes grouped by availability zone. A routing instance may have one or more connected virtual networks.cic_private_connection_info: Information about private connections to the RI.status: RI state. It may take the following values:ACTIVE: RI is active.CREATING: RI is being created.UPDATING: RI is being updated.DELETING: RI is being deleted.