索引
EdgeNetwork(接口)CreateInterconnectAttachmentRequest(消息)CreateNetworkRequest(消息)CreateRouteRequest(消息)CreateRouterRequest(消息)CreateSubnetRequest(消息)DeleteInterconnectAttachmentRequest(消息)DeleteNetworkRequest(消息)DeleteRouteRequest(消息)DeleteRouterRequest(消息)DeleteSubnetRequest(消息)DiagnoseInterconnectRequest(消息)DiagnoseInterconnectResponse(消息)DiagnoseNetworkRequest(消息)DiagnoseNetworkResponse(消息)DiagnoseNetworkResponse.NetworkStatus(消息)DiagnoseNetworkResponse.NetworkStatus.MacsecStatus(枚举)DiagnoseRouterRequest(消息)DiagnoseRouterResponse(消息)GetInterconnectAttachmentRequest(消息)GetInterconnectRequest(消息)GetNetworkRequest(消息)GetRouteRequest(消息)GetRouterRequest(消息)GetSubnetRequest(消息)GetZoneRequest(消息)(已弃用)InitializeZoneRequest(消息)InitializeZoneResponse(消息)Interconnect(消息)Interconnect.InterconnectType(枚举)InterconnectAttachment(消息)InterconnectDiagnostics(消息)InterconnectDiagnostics.LinkLACPStatus(消息)InterconnectDiagnostics.LinkLACPStatus.State(枚举)InterconnectDiagnostics.LinkLLDPStatus(消息)InterconnectDiagnostics.LinkStatus(消息)InterconnectDiagnostics.PacketCounts(消息)LinkLayerAddress(消息)ListInterconnectAttachmentsRequest(消息)ListInterconnectAttachmentsResponse(消息)ListInterconnectsRequest(消息)ListInterconnectsResponse(消息)ListNetworksRequest(消息)ListNetworksResponse(消息)ListRoutersRequest(消息)ListRoutersResponse(消息)ListRoutesRequest(消息)ListRoutesResponse(消息)ListSubnetsRequest(消息)ListSubnetsResponse(消息)ListZonesRequest(消息)(已弃用)ListZonesResponse(消息)(已弃用)Network(消息)OperationMetadata(消息)RemotePeeringNetworkType(枚举)ResourceState(枚举)Route(消息)Router(消息)Router.Bgp(消息)Router.BgpPeer(消息)Router.Interface(消息)RouterStatus(消息)RouterStatus.BgpPeerStatus(消息)RouterStatus.BgpPeerStatus.BgpStatus(枚举)RouterStatus.PrefixCounter(消息)RouterStatus.RouteStatus(消息)RouterStatus.RouteStatus.RouteInstallStatus(枚举)Subnet(消息)Subnet.BondingType(枚举)SubnetStatus(消息)UpdateRouterRequest(消息)UpdateSubnetRequest(消息)Zone(消息)
EdgeNetwork
EdgeNetwork API 为 GEC 客户提供代管式高可用性云动态网络配置服务,以支持边缘应用和网络功能解决方案。这样,客户就可以轻松定义和配置网络设置和属性,以满足工作负载要求。
| CreateInterconnectAttachment |
|---|
|
在给定的项目和位置中创建新 InterconnectAttachment。
|
| CreateNetwork |
|---|
|
在给定的项目和位置中创建新网络。
|
| CreateRoute |
|---|
|
在给定的项目和位置中创建新路由。
|
| CreateRouter |
|---|
|
在给定的项目和位置中创建一个新路由器。
|
| CreateSubnet |
|---|
|
在给定的项目和位置中创建新子网。
|
| DeleteInterconnectAttachment |
|---|
|
删除单个 InterconnectAttachment。
|
| DeleteNetwork |
|---|
|
删除单个 Network。
|
| DeleteRoute |
|---|
|
删除单个 Route。
|
| DeleteRouter |
|---|
|
删除单个路由器。
|
| DeleteSubnet |
|---|
|
删除单个子网。
|
| DiagnoseInterconnect |
|---|
|
获取单个互连资源的诊断信息。
|
| DiagnoseNetwork |
|---|
|
获取单个网络资源的诊断信息。
|
| DiagnoseRouter |
|---|
|
获取单个路由器资源的诊断信息。
|
| GetInterconnect |
|---|
|
获取单个互连的详细信息。
|
| GetInterconnectAttachment |
|---|
|
获取单个 InterconnectAttachment 的详细信息。
|
| GetNetwork |
|---|
|
获取单个网络的详细信息。
|
| GetRoute |
|---|
|
获取单个路由的详细信息。
|
| GetRouter |
|---|
|
获取单个路由器的详细信息。
|
| GetSubnet |
|---|
|
获取单个子网的详细信息。
|
| GetZone |
|---|
|
已废弃:未实现。获取单个可用区的详细信息。
|
| InitializeZone |
|---|
|
InitializeZone 将初始化项目中可用区的资源。
|
| ListInterconnectAttachments |
|---|
|
列出给定项目和位置中的 InterconnectAttachment。
|
| ListInterconnects |
|---|
|
列出给定项目和位置中的互连。
|
| ListNetworks |
|---|
|
列出给定项目和位置中的网络。
|
| ListRouters |
|---|
|
列出给定项目和位置中的路由器。
|
| ListRoutes |
|---|
|
列出给定项目和位置中的路由。
|
| ListSubnets |
|---|
|
列出给定项目和位置中的子网。
|
| ListZones |
|---|
|
已废弃:未实现。列出给定项目和位置中的可用区。
|
| UpdateRouter |
|---|
|
更新单个路由器的参数。
|
| UpdateSubnet |
|---|
|
更新单个子网的参数。
|
CreateInterconnectAttachmentRequest
用于创建 InterconnectAttachment 的消息
| 字段 | |
|---|---|
parent |
必需。父级的值。 |
interconnect_attachment_id |
必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 interconnect_attachment_id |
interconnect_attachment |
必需。正在创建的资源 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateNetworkRequest
用于创建网络的消息
| 字段 | |
|---|---|
parent |
必需。父级的值。 |
network_id |
必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 network_id |
network |
必需。正在创建的资源 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateRouteRequest
请求创建新路线的消息。
| 字段 | |
|---|---|
parent |
必需。父级的值。 |
route_id |
必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 network_id |
route |
必需。正在创建的资源 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateRouterRequest
用于创建路由器的消息
| 字段 | |
|---|---|
parent |
必需。父级的值。 |
router_id |
必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 router_id |
router |
必需。正在创建的资源 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateSubnetRequest
用于创建子网的消息
| 字段 | |
|---|---|
parent |
必需。父级的值。 |
subnet_id |
必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 subnet_id |
subnet |
必需。正在创建的资源 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteInterconnectAttachmentRequest
用于删除 InterconnectAttachment 的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteNetworkRequest
删除网络时显示的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteRouteRequest
用于删除路由的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteRouterRequest
用于删除路由器的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteSubnetRequest
用于删除子网的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DiagnoseInterconnectRequest
用于请求特定可用区内互连诊断的消息。
| 字段 | |
|---|---|
name |
必需。互连资源的名称。 |
DiagnoseInterconnectResponse
DiagnoseInterconnectResponse 包含特定互连的当前诊断信息。
| 字段 | |
|---|---|
update_time |
上次更新互连诊断的时间。 |
result |
特定互连的网络状态。 |
DiagnoseNetworkRequest
用于请求特定可用区内网络诊断的消息。
| 字段 | |
|---|---|
name |
必需。网络资源的名称。 |
DiagnoseNetworkResponse
DiagnoseNetworkResponse 包含特定网络的当前状态。
| 字段 | |
|---|---|
update_time |
上次更新网络状态的时间。 |
result |
特定网络的网络状态。 |
NetworkStatus
NetworkStatus 包含当前网络下的子网的状态列表。
| 字段 | |
|---|---|
subnet_status[] |
当前网络下的子网状态列表。 |
macsec_status_internal_links |
内部链接的 MACsec 状态。 |
MacsecStatus
表示可用区链路的 MACsec 会话状态。
| 枚举 | |
|---|---|
MACSEC_STATUS_UNSPECIFIED |
未指定 MACsec 状态,可能是因为缺少指标。 |
SECURE |
所有相关链路都至少有一个 MACsec 会话处于启动状态。 |
UNSECURE |
至少有一个相关链路没有任何 MACsec 会话。 |
DiagnoseRouterRequest
用于请求特定可用区内路由器诊断的消息。
| 字段 | |
|---|---|
name |
必需。路由器资源的名称。 |
DiagnoseRouterResponse
DiagnoseRouterResponse 包含特定路由器的当前状态。
| 字段 | |
|---|---|
update_time |
上次更新路由器状态的时间。 |
result |
特定路由器的网络状态。 |
GetInterconnectAttachmentRequest
用于获取 InterconnectAttachment 的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
GetInterconnectRequest
用于获取互连的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
GetNetworkRequest
用于获取网络的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
GetRouteRequest
获取路由的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
GetRouterRequest
用于获取路由器的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
GetSubnetRequest
用于获取子网的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
GetZoneRequest
已废弃:未实现。获取可用区的消息
| 字段 | |
|---|---|
name |
必需。资源的名称 |
InitializeZoneRequest
用于初始化指定可用区的消息
| 字段 | |
|---|---|
name |
必需。可用区资源的名称。 |
InitializeZoneResponse
此类型没有字段。
初始化可用区的响应
互连
描述 Interconnect 对象的消息
| 字段 | |
|---|---|
name |
必需。互连的规范资源名称。 |
create_time |
仅限输出。子网的创建时间。 |
update_time |
仅限输出。上次更新子网的时间。 |
labels |
与此资源关联的标签。 |
description |
可选。资源的自由文本说明。长度上限为 1024 个字符。 |
interconnect_type |
可选。互连类型,目前仅采用值“DEDICATED”。 |
uuid |
仅限输出。链接的唯一标识符。 |
device_cloud_resource_name |
仅限输出。开关设备的 Cloud 资源名称。 |
physical_ports[] |
仅限输出。构成互连的物理端口(例如 TenGigE0/0/0/1)。 |
remote_peering_network_type |
可选。互连的远程对等互连网络类型。启用对等互连分离时,此参数是必需的。 |
InterconnectType
互连类型。
| 枚举 | |
|---|---|
INTERCONNECT_TYPE_UNSPECIFIED |
未指定。 |
DEDICATED |
专用互连。 |
InterconnectAttachment
描述 InterconnectAttachment 对象的消息
| 字段 | |
|---|---|
name |
必需。互连连接的规范资源名称。 |
create_time |
仅限输出。互连连接的创建时间。 |
update_time |
仅限输出。上次更新互连连接的时间。 |
labels |
与此资源关联的标签。 |
description |
可选。资源的自由文本说明。长度上限为 1024 个字符。 |
interconnect |
必需。此连接的流量将遍历的基础互连对象的规范名称。名称采用 |
network |
可选。规范网络名称,格式为 |
vlan_id |
必需。用户提供的 VLAN ID。必须在整个网站中具有唯一性。 |
mtu |
虚拟边缘云的 IP (L3) MTU 值。有效值为:1500 和 9000。如果未设置,则默认为 1500。 |
state |
仅限输出。通过配置推送将资源推送到设备的当前阶段。 |
peering_type |
可选。底层互连的远程对等互连网络类型。启用对等互连分离时,此参数是必需的。 |
InterconnectDiagnostics
有关互连的诊断信息,其中包含有关 Google 端连接的详细和最新技术信息。
| 字段 | |
|---|---|
mac_address |
互连的捆绑包接口的 MAC 地址。 |
link_layer_addresses[] |
LinkLayerAddress 列表,描述此互连的邻居的 IP 地址和相应的链路层地址。 |
links[] |
LinkStatus 对象的列表,用于描述互连上每个链路的状态。 |
LinkLACPStatus
描述 LACP 链路的状态。
| 字段 | |
|---|---|
state |
LACP 链路的状态。 |
google_system_id |
LACP 交换中 Google 端的端口的系统 ID。 |
neighbor_system_id |
LACP 交换中邻居端的端口的系统 ID。 |
aggregatable |
值为 true 表示参与者允许将该链接用作汇总的一部分。值为 false 表示该链接应作为单独的链接使用。 |
collecting |
如果为 true,则参与者正在收集链路上的传入帧,否则为 false |
distributing |
如果为 true,则表示参与者正在分发传出帧;如果为 false,则表示分发功能已停用 |
州
LACP 链路的状态枚举。
| 枚举 | |
|---|---|
UNKNOWN |
默认状态,表示状态处于未知状态。 |
ACTIVE |
已在捆绑套装中配置了链路,并且链路处于有效状态。 |
DETACHED |
未在捆绑包中配置链路,这意味着对象的其余部分应为空。 |
LinkLLDPStatus
描述 LLDP 链路。
| 字段 | |
|---|---|
peer_system_name |
对等系统的管理分配名称。 |
peer_system_description |
LLDP 对等方的网络实体的文本说明。 |
peer_chassis_id |
与传输 LLDP 代理关联的端点标识符的对等机箱组件。 |
peer_chassis_id_type |
对等机箱标识符字符串的格式和来源。 |
peer_port_id |
与传输 LLDP 代理关联的端点标识符的端口组件。如果指定的端口是 IEEE 802.3 中继器端口,则此 TLV 为可选。 |
peer_port_id_type |
对等端口标识符字符串的格式和来源。 |
LinkStatus
描述互连连接上各链路的状态。
| 字段 | |
|---|---|
circuit_id |
此链路的唯一 ID,由 Google 在开通期间分配。 |
lacp_status |
描述 LACP 链路的状态。 |
lldp_statuses[] |
LinkLLDPStatus 对象列表,用于描述互连上每个链路的每个对等端的 LLDP 状态。 |
packet_counts |
此链路的数据包计数特定统计信息。 |
PacketCounts
包含一组与接口相关的统计信息对象。
| 字段 | |
|---|---|
inbound_unicast |
已传送的数据包数。 |
inbound_errors |
包含错误的入站数据包数量。 |
inbound_discards |
即使未检测到任何错误,系统仍选择丢弃的入站数据包数量,以防止这些数据包被传送。 |
outbound_unicast |
请求传输的数据包总数。 |
outbound_errors |
因错误而无法传输的出站数据包数量。 |
outbound_discards |
即使未检测到任何错误,仍被选择丢弃以防止其传输的出站数据包数量。 |
LinkLayerAddress
LinkLayerAddress 包含 IP 地址和相应的链路层地址。
| 字段 | |
|---|---|
mac_address |
此邻居的 MAC 地址。 |
ip_address |
此邻居的 IP 地址。 |
ListInterconnectAttachmentsRequest
用于请求 InterconnectAttachments 列表的消息
| 字段 | |
|---|---|
parent |
必需。ListInterconnectAttachmentsRequest 的父级值 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListInterconnectAttachmentsResponse
对列出 InterconnectAttachment 的响应消息
| 字段 | |
|---|---|
interconnect_attachments[] |
InterconnectAttachment 的列表 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListInterconnectsRequest
请求互连列表的消息
| 字段 | |
|---|---|
parent |
必需。ListInterconnectsRequest 的父级值 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListInterconnectsResponse
对列出互连的响应消息
| 字段 | |
|---|---|
interconnects[] |
互连列表 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListNetworksRequest
用于请求网络列表的消息
| 字段 | |
|---|---|
parent |
必需。ListNetworksRequest 的父级值 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListNetworksResponse
对列出网络的响应消息
| 字段 | |
|---|---|
networks[] |
网络列表 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListRoutersRequest
用于请求路由器列表的消息
| 字段 | |
|---|---|
parent |
必需。ListRoutersRequest 的父级值 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListRoutersResponse
对列出路由器的响应消息
| 字段 | |
|---|---|
routers[] |
路由器列表 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListRoutesRequest
用于请求路由列表的消息
| 字段 | |
|---|---|
parent |
必需。ListRoutesRequest 的父级值 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListRoutesResponse
对列出路由的响应消息
| 字段 | |
|---|---|
routes[] |
路由列表 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListSubnetsRequest
用于请求子网列表的消息
| 字段 | |
|---|---|
parent |
必需。ListSubnetsRequest 的父级值 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListSubnetsResponse
对列出子网的响应消息
| 字段 | |
|---|---|
subnets[] |
子网列表 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListZonesRequest
已废弃:未实现。用于请求区域列表的消息
| 字段 | |
|---|---|
parent |
必需。ListZonesRequest 的父级值 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListZonesResponse
已废弃:未实现。对列出可用区的响应消息
| 字段 | |
|---|---|
zones[] |
区域列表 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
网络
描述 Network 对象的消息
| 字段 | |
|---|---|
name |
必需。网络的规范资源名称。 |
create_time |
仅限输出。网络的创建时间。 |
update_time |
仅限输出。上次更新网络的时间。 |
labels |
与此资源关联的标签。 |
description |
可选。资源的自由文本说明。长度上限为 1024 个字符。 |
mtu |
网络的 IP (L3) MTU 值。有效值为:1500 和 9000。如果未设置,则默认为 1500。 |
OperationMetadata
表示长时间运行的操作的元数据。
| 字段 | |
|---|---|
create_time |
仅供输出。操作的创建时间。 |
end_time |
仅供输出。操作完成运行的时间。 |
target |
仅限输出。由服务器定义的操作目标的资源路径。 |
verb |
仅限输出。操作执行的谓词的名称。 |
status_message |
仅限输出。人类可读的操作状态(如果有)。 |
requested_cancellation |
仅限输出。标识用户是否已请求取消操作。已成功取消的操作具有 [Operation.error][] 值且 |
api_version |
仅限输出。用于启动操作的 API 版本。 |
RemotePeeringNetworkType
定义接口的远程对等互连目标。启用对等互连分离时,此参数是必需的。
| 枚举 | |
|---|---|
REMOTE_PEERING_NETWORK_TYPE_UNSPECIFIED |
未指定。 |
REMOTE_PEERING_NETWORK_TYPE_CUSTOMER_INTERNAL |
客户的可信内部网络。 |
REMOTE_PEERING_NETWORK_TYPE_CUSTOMER_INTERNET |
客户的可访问互联网的不可信网络。 |
ResourceState
ResourceState 描述资源的状态。新创建的资源的正常生命周期为:PENDING -> PROVISIONING -> RUNNING。正在删除的现有资源的正常生命周期为:RUNNING -> DELETING。处理期间发生的任何故障都会导致资源处于 SUSPENDED 状态。
| 枚举 | |
|---|---|
STATE_UNKNOWN |
未指定状态。 |
STATE_PENDING |
正在准备将资源应用于机架。 |
STATE_PROVISIONING |
已开始将资源应用于机架。 |
STATE_RUNNING |
资源已推送到机架。 |
STATE_SUSPENDED |
未能将资源推送到机架。 |
STATE_DELETING |
资源正在删除中。 |
路由
描述 Route 对象的消息
| 字段 | |
|---|---|
name |
必需。路由的规范资源名称。 |
create_time |
仅限输出。路由的创建时间。 |
update_time |
仅限输出。上次更新路线的时间。 |
labels |
可选。与此资源关联的标签。 |
network |
必需。此路由所属的网络。 |
destination_cidr |
必需。CIDR 格式的子网。 |
next_hop_address |
必需。要用作此路由下一个跃点的 IP 地址。必须使用与 |destination_cidr| 相同的协议。 |
state |
仅限输出。通过配置推送将资源推送到设备的当前阶段。 |
description |
可选。资源的自由文本说明。长度上限为 1024 个字符。 |
路由器
描述 Router 对象的消息
| 字段 | |
|---|---|
name |
必需。路由器的规范资源名称。 |
create_time |
仅限输出。路由器的创建时间。 |
update_time |
仅限输出。上次更新路由器的时间。 |
labels |
与此资源关联的标签。 |
description |
可选。资源的自由文本说明。长度上限为 1024 个字符。 |
network |
必需。此路由器所属网络的规范名称。名称采用 |
interface[] |
路由器接口。 |
bgp_peer[] |
BGP 对等端。 |
bgp |
此路由器特有的 BGP 信息。 |
state |
仅限输出。通过配置推送将资源推送到设备的当前阶段。 |
route_advertisements[] |
可选。采用 IP/长度格式的 CIDR 列表,用于从此路由器作为静态路由向北通告。 |
Bgp
此路由器特有的 BGP 信息。
| 字段 | |
|---|---|
asn |
本地分配的 BGP ASN。 |
keepalive_interval_in_seconds |
两次向对等端发送 BGP keepalive 消息的时间间隔,以秒为单位。默认值为 20,值介于 20 到 60 之间。 |
BgpPeer
BGPPeer 定义了用于构建 BGP 会话的对等端第 3 层信息。
| 字段 | |
|---|---|
name |
此 BGP 对等端的名称。在 Zones 资源中是唯一的。 |
interface |
与 BGP 对等方关联的 RouterInterface 的名称。 |
interface_ipv4_cidr |
Google 内部接口的 IP 范围。 |
interface_ipv6_cidr |
Google 内部接口的 IPv6 范围。 |
peer_ipv4_cidr |
Google 外部的 BGP 接口的 IP 范围。 |
peer_ipv6_cidr |
Google 外部 BGP 接口的 IPv6 范围。 |
peer_asn |
对等 BGP 自治系统编号 (ASN)。每个 BGP 接口可以使用不同的值。 |
local_asn |
仅限输出。本地 BGP 自治系统编号 (ASN)。此字段为 ST_NOT_REQUIRED,因为它存储专用 ASN,这些 ASN 在其使用区域之外毫无意义。 |
接口
路由器接口定义了用于构建 BGP 会话的 GDCE 区域端第 3 层信息。
| 字段 | |
|---|---|
name |
此接口条目的名称。在 Zones 资源中是唯一的。 |
ipv4_cidr |
接口的 IP 地址和范围。 |
ipv6_cidr |
接口的 IPv6 地址和范围。 |
linked_interconnect_attachment |
关联的互连连接的规范名称。 |
subnetwork |
此接口所属子网资源的规范名称。 |
loopback_ip_addresses[] |
在路由器中创建环回接口(如果指定)。IP 地址的数量必须与 TOR 设备的数量一致。 |
RouterStatus
描述路由器的当前状态。
| 字段 | |
|---|---|
network |
此路由器所属网络的规范名称。 |
bgp_peer_status[] |
BgpPeerStatus 对象列表,描述了与此路由器相关的所有 BGP 对等体。 |
static_route_status[] |
RouteStatus 列表,描述与此路由器相关的所有北向路由通告。 |
BgpPeerStatus
BGP 对等体的状态。
| 字段 | |
|---|---|
name |
此 BGP 对等端的名称。在路由器资源中是唯一的。 |
ip_address |
本地 BGP 接口的 IP 地址。 |
peer_ip_address |
远程 BGP 接口的 IP 地址。 |
status |
BGP 的当前状态。 |
state |
RFC1771 中指定的 BGP 状态。 |
uptime |
此会话已持续的时间。格式:14 年 51 周 6 天 23 小时 59 分 59 秒 |
uptime_seconds |
此会话已启动的时间(以秒为单位)。 |
prefix_counter |
前缀计数集合。 |
BgpStatus
BGP 对等体的状态:{UP, DOWN}
| 枚举 | |
|---|---|
UNKNOWN |
默认状态,表示 BGP 会话处于未知状态。 |
UP |
“UP”状态表示 BGP 会话已建立。 |
DOWN |
DOWN 状态表示 BGP 会话尚未建立。 |
PrefixCounter
PrefixCounter 包含一系列与前缀相关的计数。
| 字段 | |
|---|---|
advertised |
通告的前缀数量。 |
denied |
被拒绝的前缀数量。 |
received |
收到的前缀数量。 |
sent |
已发送的前缀数量。 |
suppressed |
已抑制的前缀数量。 |
withdrawn |
已撤消的前缀数量。 |
RouteStatus
RouteStatus 包含与路由器上通告的自定义北向静态路由相关的指标对应的字段。
| 字段 | |
|---|---|
network |
此路由所属网络的名称。 |
prefix |
通告的前缀(CIDR 格式)。 |
next_hop |
此路由的下一个跃点(IP 地址)。 |
next_hop_reachable |
下一个跃点是否可访问。 |
route_install_status |
表示路线安装状态的枚举。 |
route_install_status_additional_info |
一个详细说明 route_install_status 的字符串(如果有更多信息,例如,如果出现错误,我们将在此字段中包含一些相关信息)。 |
route |
路线的名称(请参阅 Route.name)。 |
device |
报告此 RouteStatus 的设备的名称。 |
RouteInstallStatus
一个枚举,用于汇总路由的安装状态。
| 枚举 | |
|---|---|
ROUTE_INSTALL_STATUS_UNSPECIFIED |
未指定安装状态。 |
ROUTE_INSTALL_STATUS_ACTIVE |
路由已正确安装且处于活跃状态。 |
ROUTE_INSTALL_STATUS_PENDING |
路由尚未安装,但没有错误(例如,路由正在安装中) |
ROUTE_INSTALL_STATUS_FAILED |
由于发生错误,路由安装失败。 |
子网
描述子网对象的消息
| 字段 | |
|---|---|
name |
必需。子网的规范资源名称。 |
create_time |
仅限输出。子网的创建时间。 |
update_time |
仅限输出。上次更新子网的时间。 |
labels |
与此资源关联的标签。 |
description |
可选。资源的自由文本说明。长度上限为 1024 个字符。 |
network |
必需。此子网所属的网络。 |
ipv4_cidr[] |
此子网拥有的 IPv4 地址的范围。 |
ipv6_cidr[] |
此子网拥有的 IPv6 地址的范围。 |
vlan_id |
可选。用户提供的 VLAN ID。如果未指定,系统会自动分配一个。 |
bonding_type |
可选。子网创建中的绑定类型指定了要创建的 VLAN 将存在于绑定端口类型、非绑定端口类型还是这两种端口类型上。此外,此标志用于设置特定网络配置,集群随后可以根据绑定选择将其用于其工作负载。 |
state |
仅限输出。通过配置推送将资源推送到设备的当前阶段。 |
BondingType
子网中的绑定类型。
| 枚举 | |
|---|---|
BONDING_TYPE_UNSPECIFIED |
如果用户在创建 VLAN 时选择不指定绑定类型,则默认情况下,绑定类型将为“未指定”。这将被视为混合绑定,其中 VLAN 将与机器建立绑定和非绑定连接。 |
BONDED |
多宿主。 |
NON_BONDED |
单宿主。 |
SubnetStatus
SubnetStatus 包含有关此子网资源的详细和最新技术信息。
| 字段 | |
|---|---|
name |
CCFE 子网资源的名称。 |
mac_address |
BVI MAC 地址。 |
link_layer_addresses[] |
LinkLayerAddress 列表,描述了此子网的邻居的 IP 地址和相应的链路层地址。 |
UpdateRouterRequest
更新路由器的消息
| 字段 | |
|---|---|
update_mask |
必需。字段掩码用于指定更新要在 Router 资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果用户未提供掩码,则所有字段都将被覆盖。 |
router |
必需。正在更新的资源 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
UpdateSubnetRequest
更新子网的消息
| 字段 | |
|---|---|
update_mask |
必需。字段掩码用于指定更新要在 Subnet 资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果用户未提供掩码,则所有字段都将被覆盖。 |
subnet |
必需。正在更新的资源 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
可用区
Google Edge Cloud 可用区。
| 字段 | |
|---|---|
name |
必需。可用区的资源名称。 |
create_time |
仅限输出。区域的创建时间。 |
update_time |
仅限输出。上次更新可用区的时间。 |
labels |
已废弃:未实现。标签作为键值对。 |
layout_name |
已废弃:未实现。部署布局类型。 |