Manage Cloud Routers

gcloud

If you want to use the command-line examples in this guide, do the following:

1. Install or update to the latest version of the Google Cloud CLI.
2. Set a default region and zone.

API

If you want to use the API examples in this guide, set up API access.

Console

1. In the Google Cloud console, go to the Cloud Routers page.

   Go to Cloud Routers

2. On the Cloud Routers page, view a list of your Cloud Routers.

gcloud

Run the list command. To restrict the list to only one region, specify --filter="region:(<var>REGION</var>).

  gcloud compute routers list \
      --project=PROJECT_ID \
      [--filter="region:(REGION)]

Replace the following:

• PROJECT_ID: the ID of the project for which you want to list Cloud Routers
• REGION: the region for which you want to list routers—for example, asia-east1

The output is similar to the following:

  NAME        REGION       NETWORK
  my-router   asia-east1   my-network

API

Use the routers.aggregatedList method:

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/aggregated/routers

Replace PROJECT_ID with the ID of the project for which you want to list Cloud Routers.

To list only the Cloud Routers in a specific region, use the routers.list method:

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/routers

Replace the following:

• PROJECT_ID: the ID of the project for which you want to list Cloud Routers
• REGION: the region for which you want to list Cloud Routers

gcloud

Use the gcloud compute routers update command:

gcloud compute routers update ROUTER_NAME
    --region=REGION

Replace the following:

• ROUTER_NAME: the name of the Cloud Router that you want to update
• REGION: the region where the Cloud Router resides

API

Use the routers.update method:

PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/routers/ROUTER_NAME

Replace the following:

• PROJECT_ID: the ID of the project for which you want to list Cloud Routers
• REGION: the region where the Cloud Router resides
• ROUTER_NAME: the name of the Cloud Router that you want to update

gcloud

Use the gcloud compute routers get-status command.

gcloud compute routers get-status ROUTER_NAME \
    --project=PROJECT_ID \
    --region=REGION

Replace the following:

• ROUTER_NAME: the name of the Cloud Router that you want to get the status of
• PROJECT_ID: the project ID that the Cloud Router belongs to
• REGION: the region where the Cloud Router resides

API

Use the routers.getRouterStatus method with an empty request body:

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/routers/ROUTER_NAME/getRouterStatus

Replace the following:

• PROJECT_ID: the project ID that the Cloud Router belongs to
• REGION: the region where the Cloud Router resides
• ROUTER_NAME: the name of the Cloud Router that you want to get the status of

Console

1. In the Google Cloud console, go to the Cloud Routers page.

   Go to Cloud Routers

2. Select the checkbox next to the Cloud Router that you want to delete.

3. Click deleteDelete.

gcloud

Run the delete command. Specify the name and location of the Cloud Router that you want to delete.

gcloud compute routers delete ROUTER_NAME \
    --project=PROJECT_ID \
    --region=REGION

Replace the following:

• ROUTER_NAME: the name of the Cloud Router that you want to delete

• PROJECT_ID: the ID of the project that contains the Cloud Router that you want to delete

• REGION: the region in which the Cloud Router is located

The output is similar to the following:

Deleted [https://www.googleapis.com/compute/v1/projects/PROJECT_ID/regions/asia-east1/routers/ROUTER_NAME].

API

Use the routers.delete method:

DELETE https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/routers/ROUTER_NAME

Replace the following:

• PROJECT_ID: the ID of the project that contains the Cloud Router that you want to delete
• REGION: the region where the Cloud Router is located
• ROUTER_NAME: the name of the Cloud Router