REST Resource: projects.locations.zones.routers

リソース: ルーター

Router オブジェクトについて説明するメッセージ

JSON 表現 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "network": string,
  "interface": [
    {
      object (Interface)
    }
  ],
  "bgpPeer": [
    {
      object (BgpPeer)
    }
  ],
  "bgp": {
    object (Bgp)
  },
  "state": enum (ResourceState),
  "routeAdvertisements": [
    string
  ]
}
フィールド
name

string

必須。ルーターの正規リソース名。
createTime

string (Timestamp format)

出力専用。ルーターが作成された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。ルーターが最後に更新された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

このリソースに関連付けられたラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
description

string

省略可。フリーテキストでのリソースの説明。最大長は 1,024 文字です。
network

string

必須。このルーターが属するネットワークの正規名。名前は projects/{project}/locations/{location}/zones/{zone}/networks/{network} の形式です。
interface[]

object (Interface)

ルーター インターフェース。
bgpPeer[]

object (BgpPeer)

BGP ピア。
bgp

object (Bgp)

このルーターに固有の BGP 情報。
state

enum (ResourceState)

出力専用。構成のプッシュによるデバイスへのリソースの現在のステージ。
routeAdvertisements[]

string

省略可。このルーターから静的ルートとして北方向にアドバタイズする IP/長さ形式の CIDR のリスト。

インターフェース

ルーター インターフェースは、BGP セッションを構築するための GDCE ゾーン側のレイヤ 3 情報を定義します。

JSON 表現 
{
  "name": string,
  "ipv4Cidr": string,
  "ipv6Cidr": string,
  "linkedInterconnectAttachment": string,
  "subnetwork": string,
  "loopbackIpAddresses": [
    string
  ]
}
フィールド
name

string

このインターフェース エントリの名前。Zones リソース内で一意。
ipv4Cidr

string

インターフェースの IP アドレスと範囲。
ipv6Cidr

string

インターフェースの IPv6 アドレスと範囲。
linkedInterconnectAttachment

string

リンクされた相互接続のアタッチメントの正規名。
subnetwork

string

このインターフェースが属するサブネットワーク リソースの正規名。
loopbackIpAddresses[]

string

指定した場合は、ルーターにループバック インターフェースを作成します。IP アドレスの数は、TOR デバイスの数と一致する必要があります。

BgpPeer

BGPPeer は、BGP セッションを構築するためのピア側のレイヤ 3 情報を定義します。

JSON 表現 
{
  "name": string,
  "interface": string,
  "interfaceIpv4Cidr": string,
  "interfaceIpv6Cidr": string,
  "peerIpv4Cidr": string,
  "peerIpv6Cidr": string,
  "peerAsn": integer,
  "localAsn": integer
}
フィールド
name

string

この BGP ピアの名前。Zones リソース内で一意。
interface

string

BGP ピアが関連付けられている RouterInterface の名前。
interfaceIpv4Cidr

string

Google 内のインターフェースの IP 範囲。
interfaceIpv6Cidr

string

Google 内のインターフェースの IPv6 範囲。
peerIpv4Cidr

string

Google 外の BGP インターフェースの IP 範囲。
peerIpv6Cidr

string

Google 外の BGP インターフェースの IPv6 範囲。
peerAsn

integer (uint32 format)

ピア BGP 自律システム番号（ASN）。BGP インターフェースごとに異なる値を使用できます。
localAsn

integer (uint32 format)

出力専用。ローカル BGP 自律システム番号（ASN）。このフィールドは ST_NOT_REQUIRED です。これは、プライベート ASN を保存するためです。プライベート ASN は、使用されているゾーンの外部では意味がありません。

Bgp

このルーターに固有の BGP 情報。

JSON 表現 
{
  "asn": integer,
  "keepaliveIntervalInSeconds": integer
}
フィールド
asn

integer (uint32 format)

ローカルで割り当てられた BGP ASN。
keepaliveIntervalInSeconds

integer (uint32 format)

ピアに送信される BGP キープアライブ メッセージの間隔（秒）。デフォルトは 20 で、値は 20 ～ 60 です。

メソッド

create

 指定されたプロジェクトとロケーションで新しい Router を作成します。

delete

 1 つの Router を削除します。

diagnose

 単一のルーター リソースの診断情報を取得します。

get

 1 つの Router の詳細を取得します。

list

 指定されたプロジェクトとロケーションの Router を一覧表示します。

patch

 1 つの Router のパラメータを更新します。