Cloud Router を管理する

このドキュメントでは、Cloud Router の一覧表示、更新、ステータスの取得、削除を行う方法について説明します。

始める前に

gcloud

このガイドのコマンドラインの例を使用する場合は、次の操作を行います。

  1. Google Cloud CLI の最新バージョンをインストールするか、最新バージョンに更新します。
  2. デフォルトのリージョンとゾーンを設定します。

API

このガイドの API の例を使用する場合は、API アクセスを設定します。

Cloud Router を一覧表示する

プロジェクト内のすべての Cloud Router を一覧表示するには、次の操作を行います。

コンソール

  1. Trusted Cloud コンソールで、[Cloud Router] ページに移動します。

    [Cloud Router] に移動

  2. [Cloud Router] ページで、Cloud Router のリストを表示します。

gcloud

list コマンドを実行します。特定のリージョンに属するものだけを表示する場合は、--filter="region:(<var>REGION</var>) を指定します。

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

次のように置き換えます。

  • PROJECT_ID: Cloud Router を一覧表示するプロジェクトの ID
  • REGION: ルーターを一覧表示するリージョン（例: asia-east1）

出力は次のようになります。

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

API

routers.aggregatedList メソッドを使用します。

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

PROJECT_ID は、Cloud Router を一覧表示するプロジェクトの ID に置き換えます。

特定のリージョン内の Cloud Router のみを一覧表示するには、routers.list メソッドを使用します。

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

次のように置き換えます。

  • PROJECT_ID: Cloud Router を一覧表示するプロジェクトの ID
  • REGION: Cloud Router を一覧表示するリージョン

Cloud Router を更新する

Cloud Router が NCC Gateway に関連付けられている場合は、次の点に注意してください。

  • ncc_gateway フィールドは更新できません。

  • patch メソッドまたは update メソッドは、リクエスト本文の一部として network フィールドを受け入れません。

gcloud

gcloud compute routers update コマンドを使用します。

gcloud compute routers update ROUTER_NAME
    --region=REGION

次のように置き換えます。

  • ROUTER_NAME: 更新する Cloud Router の名前
  • REGION: Cloud Router が存在するリージョン

API

routers.update メソッドを使用します。

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

次のように置き換えます。

  • PROJECT_ID: Cloud Router を一覧表示するプロジェクトの ID
  • REGION: Cloud Router が存在するリージョン
  • ROUTER_NAME: 更新する Cloud Router の名前

Cloud Router のステータスを取得する

gcloud

gcloud compute routers get-status コマンドを使用します。

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

次のように置き換えます。

  • ROUTER_NAME: ステータスを取得する Cloud Router の名前
  • PROJECT_ID: Cloud Router が属するプロジェクト ID
  • REGION: Cloud Router が存在するリージョン

API

空のリクエスト本文を含む routers.getRouterStatus メソッドを使用します。

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

次のように置き換えます。

  • PROJECT_ID: Cloud Router が属するプロジェクト ID
  • REGION: Cloud Router が存在するリージョン
  • ROUTER_NAME: ステータスを取得する Cloud Router の名前

Cloud Router を削除する

Cloud Router を削除する前に、別のリソース（Cloud VPN トンネルや VLAN アタッチメントなど）で使用されていないことを確認してください。Cloud Router を削除する前に、関連するリソースを削除する必要があります。ただし、Cloud Router を削除する前に BGP セッションを削除する必要はありません。

Cloud Router を削除するには、次の操作を行います。

コンソール

  1. Trusted Cloud コンソールで、[Cloud Router] ページに移動します。

    [Cloud Router] に移動

  2. 削除する Cloud Router の横にあるチェックボックスをオンにします。

  3. [削除] をクリックします。

gcloud

delete コマンドを実行します。削除する Cloud Router の名前とロケーションを指定します。

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

次のように置き換えます。

  • ROUTER_NAME: 削除する Cloud Router の名前

  • PROJECT_ID: 削除する Cloud Router を含むプロジェクトの ID

  • REGION: Cloud Router が配置されているリージョン

出力は次のようになります。

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

API

routers.delete メソッドを使用します。

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

次のように置き換えます。

  • PROJECT_ID: 削除する Cloud Router を含むプロジェクトの ID
  • REGION: Cloud Router が配置されているリージョン
  • ROUTER_NAME: Cloud Router の名前

次のステップ