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 规范化(即转换为 UTC 零时区格式并在末尾附加 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 规范化(即转换为 UTC 零时区格式并在末尾附加 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

可选。资源的自由文本说明。长度上限为 1024 个字符。

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 keepalive 消息的时间间隔,以秒为单位。默认值为 20,值介于 20 到 60 之间。

方法

create

在给定的项目和位置中创建一个新路由器。

delete

删除单个路由器。

diagnose

获取单个路由器资源的诊断信息。

get

获取单个路由器的详细信息。

list

列出给定项目和位置中的路由器。

patch

更新单个路由器的参数。