Package google.cloud.edgenetwork.v1

索引

EdgeNetwork

EdgeNetwork API 为 GEC 客户提供代管式高可用性云动态网络配置服务,以支持边缘应用和网络功能解决方案。这样,客户就可以轻松定义和配置网络设置和属性,以满足工作负载要求。

CreateInterconnectAttachment

rpc CreateInterconnectAttachment(CreateInterconnectAttachmentRequest) returns (Operation)

在给定的项目和位置中创建新 InterconnectAttachment。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

CreateNetwork

rpc CreateNetwork(CreateNetworkRequest) returns (Operation)

在给定的项目和位置中创建新网络。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

CreateRouter

rpc CreateRouter(CreateRouterRequest) returns (Operation)

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

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

CreateSubnet

rpc CreateSubnet(CreateSubnetRequest) returns (Operation)

在给定的项目和位置中创建新子网。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

DeleteInterconnectAttachment

rpc DeleteInterconnectAttachment(DeleteInterconnectAttachmentRequest) returns (Operation)

删除单个 InterconnectAttachment。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

DeleteNetwork

rpc DeleteNetwork(DeleteNetworkRequest) returns (Operation)

删除单个 Network。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

DeleteRouter

rpc DeleteRouter(DeleteRouterRequest) returns (Operation)

删除单个路由器。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

DeleteSubnet

rpc DeleteSubnet(DeleteSubnetRequest) returns (Operation)

删除单个子网。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

DiagnoseInterconnect

rpc DiagnoseInterconnect(DiagnoseInterconnectRequest) returns (DiagnoseInterconnectResponse)

获取单个互连资源的诊断信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

DiagnoseNetwork

rpc DiagnoseNetwork(DiagnoseNetworkRequest) returns (DiagnoseNetworkResponse)

获取单个网络资源的诊断信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

DiagnoseRouter

rpc DiagnoseRouter(DiagnoseRouterRequest) returns (DiagnoseRouterResponse)

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

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

GetInterconnect

rpc GetInterconnect(GetInterconnectRequest) returns (Interconnect)

获取单个互连的详细信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

GetInterconnectAttachment

rpc GetInterconnectAttachment(GetInterconnectAttachmentRequest) returns (InterconnectAttachment)

获取单个 InterconnectAttachment 的详细信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

GetNetwork

rpc GetNetwork(GetNetworkRequest) returns (Network)

获取单个网络的详细信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

GetRouter

rpc GetRouter(GetRouterRequest) returns (Router)

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

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

GetSubnet

rpc GetSubnet(GetSubnetRequest) returns (Subnet)

获取单个子网的详细信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

GetZone

rpc GetZone(GetZoneRequest) returns (Zone)

已废弃:未实现。获取单个可用区的详细信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

InitializeZone

rpc InitializeZone(InitializeZoneRequest) returns (InitializeZoneResponse)

InitializeZone 将初始化项目中可用区的资源。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

ListInterconnectAttachments

rpc ListInterconnectAttachments(ListInterconnectAttachmentsRequest) returns (ListInterconnectAttachmentsResponse)

列出给定项目和位置中的 InterconnectAttachment。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

ListInterconnects

rpc ListInterconnects(ListInterconnectsRequest) returns (ListInterconnectsResponse)

列出给定项目和位置中的互连。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

ListNetworks

rpc ListNetworks(ListNetworksRequest) returns (ListNetworksResponse)

列出给定项目和位置中的网络。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

ListRouters

rpc ListRouters(ListRoutersRequest) returns (ListRoutersResponse)

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

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

ListSubnets

rpc ListSubnets(ListSubnetsRequest) returns (ListSubnetsResponse)

列出给定项目和位置中的子网。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

ListZones

rpc ListZones(ListZonesRequest) returns (ListZonesResponse)

已废弃:未实现。列出给定项目和位置中的可用区。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

UpdateRouter

rpc UpdateRouter(UpdateRouterRequest) returns (Operation)

更新单个路由器的参数。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

UpdateSubnet

rpc UpdateSubnet(UpdateSubnetRequest) returns (Operation)

更新单个子网的参数。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview。

CreateInterconnectAttachmentRequest

用于创建 InterconnectAttachment 的消息

字段
parent

string

必需。父级的值。

interconnect_attachment_id

string

必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 interconnect_attachment_id

interconnect_attachment

InterconnectAttachment

必需。正在创建的资源

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

CreateNetworkRequest

用于创建网络的消息

字段
parent

string

必需。父级的值。

network_id

string

必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 network_id

network

Network

必需。正在创建的资源

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

CreateRouterRequest

用于创建路由器的消息

字段
parent

string

必需。父级的值。

router_id

string

必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 router_id

router

Router

必需。正在创建的资源

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

CreateSubnetRequest

用于创建子网的消息

字段
parent

string

必需。父级的值。

subnet_id

string

必需。请求对象的 ID。如果在服务器端自动生成 ID,请从 Create RPC 的 method_signature 中移除此字段和 subnet_id

subnet

Subnet

必需。正在创建的资源

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

DeleteInterconnectAttachmentRequest

用于删除 InterconnectAttachment 的消息

字段
name

string

必需。资源的名称

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

DeleteNetworkRequest

删除网络时显示的消息

字段
name

string

必需。资源的名称

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

DeleteRouterRequest

用于删除路由器的消息

字段
name

string

必需。资源的名称

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

DeleteSubnetRequest

用于删除子网的消息

字段
name

string

必需。资源的名称

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

DiagnoseInterconnectRequest

用于请求特定可用区内互连诊断的消息。

字段
name

string

必需。互连资源的名称。

DiagnoseInterconnectResponse

DiagnoseInterconnectResponse 包含特定互连的当前诊断信息。

字段
update_time

Timestamp

上次更新互连诊断的时间。

result

InterconnectDiagnostics

特定互连的网络状态。

DiagnoseNetworkRequest

用于请求特定可用区内网络诊断的消息。

字段
name

string

必需。网络资源的名称。

DiagnoseNetworkResponse

DiagnoseNetworkResponse 包含特定网络的当前状态。

字段
update_time

Timestamp

上次更新网络状态的时间。

result

NetworkStatus

特定网络的网络状态。

NetworkStatus

NetworkStatus 包含当前网络下的子网的状态列表。

字段
subnet_status[]

SubnetStatus

当前网络下的子网状态列表。

MacsecStatus

表示可用区链路的 MACsec 会话状态。

枚举
MACSEC_STATUS_UNSPECIFIED 未指定 MACsec 状态,可能是因为缺少指标。
SECURE 所有相关链路都至少有一个 MACsec 会话处于启动状态。
UNSECURE 至少有一个相关链路没有任何 MACsec 会话。

DiagnoseRouterRequest

用于请求特定可用区内路由器诊断的消息。

字段
name

string

必需。路由器资源的名称。

DiagnoseRouterResponse

DiagnoseRouterResponse 包含特定路由器的当前状态。

字段
update_time

Timestamp

上次更新路由器状态的时间。

result

RouterStatus

特定路由器的网络状态。

GetInterconnectAttachmentRequest

用于获取 InterconnectAttachment 的消息

字段
name

string

必需。资源的名称

GetInterconnectRequest

用于获取互连的消息

字段
name

string

必需。资源的名称

GetNetworkRequest

用于获取网络的消息

字段
name

string

必需。资源的名称

GetRouterRequest

用于获取路由器的消息

字段
name

string

必需。资源的名称

GetSubnetRequest

用于获取子网的消息

字段
name

string

必需。资源的名称

GetZoneRequest

已废弃:未实现。获取可用区的消息

字段
name

string

必需。资源的名称

InitializeZoneRequest

用于初始化指定可用区的消息

字段
name

string

必需。可用区资源的名称。

InitializeZoneResponse

此类型没有字段。

初始化可用区的响应

互连

描述 Interconnect 对象的消息

字段
name

string

必需。互连的规范资源名称。

create_time

Timestamp

仅限输出。子网的创建时间。

update_time

Timestamp

仅限输出。上次更新子网的时间。

labels

map<string, string>

与此资源关联的标签。

description

string

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

interconnect_type

InterconnectType

可选。互连类型,目前仅采用值“DEDICATED”。

uuid

string

仅限输出。链接的唯一标识符。

device_cloud_resource_name

string

仅限输出。开关设备的 Cloud 资源名称。

physical_ports[]

string

仅限输出。构成互连的物理端口(例如 TenGigE0/0/0/1)。

remote_peering_network_type

RemotePeeringNetworkType

可选。互连的远程对等互连网络类型。启用对等互连分离时,此参数是必需的。

InterconnectType

互连类型。

枚举
INTERCONNECT_TYPE_UNSPECIFIED 未指定。
DEDICATED 专用互连。

InterconnectAttachment

描述 InterconnectAttachment 对象的消息

字段
name

string

必需。互连连接的规范资源名称。

create_time

Timestamp

仅限输出。互连连接的创建时间。

update_time

Timestamp

仅限输出。上次更新互连连接的时间。

labels

map<string, string>

与此资源关联的标签。

description

string

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

interconnect

string

必需。此连接的流量将遍历的基础互连对象的规范名称。名称采用 projects/{project}/locations/{location}/zones/{zone}/interconnects/{interconnect} 格式。

network

string

可选。规范网络名称,格式为 projects/{project}/locations/{location}/zones/{zone}/networks/{network}。

vlan_id

int32

必需。用户提供的 VLAN ID。必须在整个网站中具有唯一性。

mtu

int32

虚拟边缘云的 IP (L3) MTU 值。有效值为:1500 和 9000。如果未设置,则默认为 1500。

state

ResourceState

仅限输出。通过配置推送将资源推送到设备的当前阶段。

peering_type

RemotePeeringNetworkType

可选。底层互连的远程对等互连网络类型。启用对等互连分离时,此参数是必需的。

InterconnectDiagnostics

有关互连的诊断信息,其中包含有关 Google 端连接的详细和最新技术信息。

字段
mac_address

string

互连的捆绑包接口的 MAC 地址。

LinkLACPStatus

描述 LACP 链路的状态。

字段
state

State

LACP 链路的状态。

google_system_id

string

LACP 交换中 Google 端的端口的系统 ID。

neighbor_system_id

string

LACP 交换中邻居端的端口的系统 ID。

aggregatable

bool

值为 true 表示参与者允许将该链接用作汇总的一部分。值为 false 表示该链接应作为单独的链接使用。

collecting

bool

如果为 true,则参与者正在收集链路上的传入帧,否则为 false

distributing

bool

如果为 true,则表示参与者正在分发传出帧;如果为 false,则表示分发功能已停用

州

LACP 链路的状态枚举。

枚举
UNKNOWN 默认状态,表示状态处于未知状态。
ACTIVE 已在捆绑套装中配置了链路,并且链路处于有效状态。
DETACHED 未在捆绑包中配置链路,这意味着对象的其余部分应为空。

LinkLLDPStatus

描述 LLDP 链路。

字段
peer_system_name

string

对等系统的管理分配名称。

peer_system_description

string

LLDP 对等方的网络实体的文本说明。

peer_chassis_id

string

与传输 LLDP 代理关联的端点标识符的对等机箱组件。

peer_chassis_id_type

string

对等机箱标识符字符串的格式和来源。

peer_port_id

string

与传输 LLDP 代理关联的端点标识符的端口组件。如果指定的端口是 IEEE 802.3 中继器端口,则此 TLV 为可选。

peer_port_id_type

string

对等端口标识符字符串的格式和来源。

LinkStatus

描述互连连接上各链路的状态。

字段
circuit_id

string

此链路的唯一 ID,由 Google 在开通期间分配。

lacp_status

LinkLACPStatus

描述 LACP 链路的状态。

lldp_statuses[]

LinkLLDPStatus

LinkLLDPStatus 对象列表,用于描述互连上每个链路的每个对等端的 LLDP 状态。

packet_counts

PacketCounts

此链路的数据包计数特定统计信息。

PacketCounts

包含一组与接口相关的统计信息对象。

字段
inbound_unicast

int64

已传送的数据包数。

inbound_errors

int64

包含错误的入站数据包数量。

inbound_discards

int64

即使未检测到任何错误,系统仍选择丢弃的入站数据包数量,以防止这些数据包被传送。

outbound_unicast

int64

请求传输的数据包总数。

outbound_errors

int64

因错误而无法传输的出站数据包数量。

outbound_discards

int64

即使未检测到任何错误,仍被选择丢弃以防止其传输的出站数据包数量。

LinkLayerAddress

LinkLayerAddress 包含 IP 地址和相应的链路层地址。

字段
mac_address

string

此邻居的 MAC 地址。

ip_address

string

此邻居的 IP 地址。

ListInterconnectAttachmentsRequest

用于请求 InterconnectAttachments 列表的消息

字段
parent

string

必需。ListInterconnectAttachmentsRequest 的父级值

page_size

int32

请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。

page_token

string

标识服务器应返回的结果页面的令牌。

filter

string

过滤结果

order_by

string

有关如何对结果进行排序的提示

ListInterconnectAttachmentsResponse

对列出 InterconnectAttachment 的响应消息

字段
interconnect_attachments[]

InterconnectAttachment

InterconnectAttachment 的列表

next_page_token

string

标识服务器应返回的结果页面的令牌。

unreachable[]

string

无法到达的位置。

ListInterconnectsRequest

请求互连列表的消息

字段
parent

string

必需。ListInterconnectsRequest 的父级值

page_size

int32

请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。

page_token

string

标识服务器应返回的结果页面的令牌。

filter

string

过滤结果

order_by

string

有关如何对结果进行排序的提示

ListInterconnectsResponse

对列出互连的响应消息

字段
interconnects[]

Interconnect

互连列表

next_page_token

string

标识服务器应返回的结果页面的令牌。

unreachable[]

string

无法到达的位置。

ListNetworksRequest

用于请求网络列表的消息

字段
parent

string

必需。ListNetworksRequest 的父级值

page_size

int32

请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。

page_token

string

标识服务器应返回的结果页面的令牌。

filter

string

过滤结果

order_by

string

有关如何对结果进行排序的提示

ListNetworksResponse

对列出网络的响应消息

字段
networks[]

Network

网络列表

next_page_token

string

标识服务器应返回的结果页面的令牌。

unreachable[]

string

无法到达的位置。

ListRoutersRequest

用于请求路由器列表的消息

字段
parent

string

必需。ListRoutersRequest 的父级值

page_size

int32

请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。

page_token

string

标识服务器应返回的结果页面的令牌。

filter

string

过滤结果

order_by

string

有关如何对结果进行排序的提示

ListRoutersResponse

对列出路由器的响应消息

字段
routers[]

Router

路由器列表

next_page_token

string

标识服务器应返回的结果页面的令牌。

unreachable[]

string

无法到达的位置。

ListSubnetsRequest

用于请求子网列表的消息

字段
parent

string

必需。ListSubnetsRequest 的父级值

page_size

int32

请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。

page_token

string

标识服务器应返回的结果页面的令牌。

filter

string

过滤结果

order_by

string

有关如何对结果进行排序的提示

ListSubnetsResponse

对列出子网的响应消息

字段
subnets[]

Subnet

子网列表

next_page_token

string

标识服务器应返回的结果页面的令牌。

unreachable[]

string

无法到达的位置。

ListZonesRequest

已废弃:未实现。用于请求区域列表的消息

字段
parent

string

必需。ListZonesRequest 的父级值

page_size

int32

请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。

page_token

string

标识服务器应返回的结果页面的令牌。

filter

string

过滤结果

order_by

string

有关如何对结果进行排序的提示

ListZonesResponse

已废弃:未实现。对列出可用区的响应消息

字段
zones[]

Zone

区域列表

next_page_token

string

标识服务器应返回的结果页面的令牌。

unreachable[]

string

无法到达的位置。

网络

描述 Network 对象的消息

字段
name

string

必需。网络的规范资源名称。

create_time

Timestamp

仅限输出。网络的创建时间。

update_time

Timestamp

仅限输出。上次更新网络的时间。

labels

map<string, string>

与此资源关联的标签。

description

string

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

mtu

int32

网络的 IP (L3) MTU 值。有效值为:1500 和 9000。如果未设置,则默认为 1500。

OperationMetadata

表示长时间运行的操作的元数据。

字段
create_time

Timestamp

仅供输出。操作的创建时间。

end_time

Timestamp

仅供输出。操作完成运行的时间。

target

string

仅限输出。由服务器定义的操作目标的资源路径。

verb

string

仅限输出。操作执行的谓词的名称。

status_message

string

仅限输出。人类可读的操作状态(如果有)。

requested_cancellation

bool

仅限输出。标识用户是否已请求取消操作。已成功取消的操作具有 [Operation.error][] 值且 google.rpc.Status.code 为 1(对应于 Code.CANCELLED)。

api_version

string

仅限输出。用于启动操作的 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 资源正在删除中。

路由器

描述 Router 对象的消息

字段
name

string

必需。路由器的规范资源名称。

create_time

Timestamp

仅限输出。路由器的创建时间。

update_time

Timestamp

仅限输出。上次更新路由器的时间。

labels

map<string, string>

与此资源关联的标签。

description

string

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

network

string

必需。此路由器所属网络的规范名称。名称采用 projects/{project}/locations/{location}/zones/{zone}/networks/{network} 格式。

interface[]

Interface

路由器接口。

bgp_peer[]

BgpPeer

BGP 对等端。

bgp

Bgp

此路由器特有的 BGP 信息。

state

ResourceState

仅限输出。通过配置推送将资源推送到设备的当前阶段。

route_advertisements[]

string

可选。采用 IP/长度格式的 CIDR 列表,用于从此路由器作为静态路由向北通告。

Bgp

此路由器特有的 BGP 信息。

字段
asn

uint32

本地分配的 BGP ASN。

keepalive_interval_in_seconds

uint32

两次向对等端发送 BGP keepalive 消息的时间间隔,以秒为单位。默认值为 20,值介于 20 到 60 之间。

BgpPeer

BGPPeer 定义了用于构建 BGP 会话的对等端第 3 层信息。

字段
name

string

此 BGP 对等端的名称。在 Zones 资源中是唯一的。

interface

string

与 BGP 对等方关联的 RouterInterface 的名称。

interface_ipv4_cidr

string

Google 内部接口的 IP 范围。

interface_ipv6_cidr

string

Google 内部接口的 IPv6 范围。

peer_ipv4_cidr

string

Google 外部的 BGP 接口的 IP 范围。

peer_ipv6_cidr

string

Google 外部 BGP 接口的 IPv6 范围。

peer_asn

uint32

对等 BGP 自治系统编号 (ASN)。每个 BGP 接口可以使用不同的值。

local_asn

uint32

仅限输出。本地 BGP 自治系统编号 (ASN)。此字段为 ST_NOT_REQUIRED,因为它存储专用 ASN,这些 ASN 在其使用区域之外毫无意义。

接口

路由器接口定义了用于构建 BGP 会话的 GDCE 区域端第 3 层信息。

字段
name

string

此接口条目的名称。在 Zones 资源中是唯一的。

ipv4_cidr

string

接口的 IP 地址和范围。

ipv6_cidr

string

接口的 IPv6 地址和范围。

linked_interconnect_attachment

string

关联的互连连接的规范名称。

subnetwork

string

此接口所属子网资源的规范名称。

loopback_ip_addresses[]

string

在路由器中创建环回接口(如果指定)。IP 地址的数量必须与 TOR 设备的数量一致。

RouterStatus

描述路由器的当前状态。

字段
network

string

此路由器所属网络的规范名称。

bgp_peer_status[]

BgpPeerStatus

BgpPeerStatus 对象列表,描述了与此路由器相关的所有 BGP 对等体。

BgpPeerStatus

BGP 对等体的状态。

字段
name

string

此 BGP 对等端的名称。在路由器资源中是唯一的。

ip_address

string

本地 BGP 接口的 IP 地址。

peer_ip_address

string

远程 BGP 接口的 IP 地址。

status

BgpStatus

BGP 的当前状态。

state

string

RFC1771 中指定的 BGP 状态。

uptime

string

此会话已持续的时间。格式:14 年 51 周 6 天 23 小时 59 分 59 秒

uptime_seconds

int64

此会话已启动的时间(以秒为单位)。

prefix_counter

PrefixCounter

前缀计数集合。

BgpStatus

BGP 对等体的状态:{UP, DOWN}

枚举
UNKNOWN 默认状态,表示 BGP 会话处于未知状态。
UP “UP”状态表示 BGP 会话已建立。
DOWN DOWN 状态表示 BGP 会话尚未建立。

PrefixCounter

PrefixCounter 包含一系列与前缀相关的计数。

字段
advertised

int64

通告的前缀数量。

denied

int64

被拒绝的前缀数量。

received

int64

收到的前缀数量。

sent

int64

已发送的前缀数量。

suppressed

int64

已抑制的前缀数量。

withdrawn

int64

已撤消的前缀数量。

子网

描述子网对象的消息

字段
name

string

必需。子网的规范资源名称。

create_time

Timestamp

仅限输出。子网的创建时间。

update_time

Timestamp

仅限输出。上次更新子网的时间。

labels

map<string, string>

与此资源关联的标签。

description

string

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

network

string

必需。此子网所属的网络。

ipv4_cidr[]

string

此子网拥有的 IPv4 地址的范围。

ipv6_cidr[]

string

此子网拥有的 IPv6 地址的范围。

vlan_id

int32

可选。用户提供的 VLAN ID。如果未指定,系统会自动分配一个。

bonding_type

BondingType

可选。子网创建中的绑定类型指定了要创建的 VLAN 将存在于绑定端口类型、非绑定端口类型还是这两种端口类型上。此外,此标志用于设置特定网络配置,集群随后可以根据绑定选择将其用于其工作负载。

state

ResourceState

仅限输出。通过配置推送将资源推送到设备的当前阶段。

BondingType

子网中的绑定类型。

枚举
BONDING_TYPE_UNSPECIFIED 如果用户在创建 VLAN 时选择不指定绑定类型,则默认情况下,绑定类型将为“未指定”。这将被视为混合绑定,其中 VLAN 将与机器建立绑定和非绑定连接。
BONDED 多宿主。
NON_BONDED 单宿主。

SubnetStatus

SubnetStatus 包含有关此子网资源的详细和最新技术信息。

字段
name

string

CCFE 子网资源的名称。

mac_address

string

BVI MAC 地址。

UpdateRouterRequest

更新路由器的消息

字段
update_mask

FieldMask

必需。字段掩码用于指定更新要在 Router 资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果用户未提供掩码,则所有字段都将被覆盖。

router

Router

必需。正在更新的资源

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

UpdateSubnetRequest

更新子网的消息

字段
update_mask

FieldMask

必需。字段掩码用于指定更新要在 Subnet 资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果用户未提供掩码,则所有字段都将被覆盖。

subnet

Subnet

必需。正在更新的资源

request_id

string

可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器将保证在第一次完成该请求后的至少 60 分钟内避免重复处理该请求。

例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。

请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。

可用区

Google Edge Cloud 可用区。

字段
name

string

必需。可用区的资源名称。

create_time

Timestamp

仅限输出。区域的创建时间。

update_time

Timestamp

仅限输出。上次更新可用区的时间。

labels
(deprecated)

map<string, string>

已废弃:未实现。标签作为键值对。

layout_name
(deprecated)

string

已废弃:未实现。部署布局类型。