索引
EdgeContainer(接口)Authorization(消息)Cluster(消息)ClusterNetworking(消息)ClusterUser(消息)CreateClusterRequest(消息)CreateNodePoolRequest(消息)CreateVpnConnectionRequest(消息)DeleteClusterRequest(消息)DeleteNodePoolRequest(消息)DeleteVpnConnectionRequest(消息)Fleet(消息)GenerateAccessTokenRequest(消息)GenerateAccessTokenResponse(消息)GetClusterRequest(消息)GetMachineRequest(消息)GetNodePoolRequest(消息)GetVpnConnectionRequest(消息)KmsKeyState(枚举)ListClustersRequest(消息)ListClustersResponse(消息)ListMachinesRequest(消息)ListMachinesResponse(消息)ListNodePoolsRequest(消息)ListNodePoolsResponse(消息)ListVpnConnectionsRequest(消息)ListVpnConnectionsResponse(消息)LocationMetadata(消息)Machine(消息)MaintenancePolicy(消息)MaintenanceWindow(消息)NodePool(消息)NodePool.LocalDiskEncryption(消息)OperationMetadata(消息)Quota(消息)RecurringTimeWindow(消息)TimeWindow(消息)UpdateClusterRequest(消息)UpdateNodePoolRequest(消息)VpnConnection(消息)VpnConnection.BgpRoutingMode(枚举)VpnConnection.Details(消息)VpnConnection.Details.CloudRouter(消息)VpnConnection.Details.CloudVpn(消息)VpnConnection.Details.State(枚举)VpnConnection.VpcProject(消息)ZoneMetadata(消息)
EdgeContainer
EdgeContainer API 用于管理 Google Edge Cloud 部署中的 Kubernetes 集群。
| CreateCluster |
|---|
|
在给定的项目和位置中创建新的集群。
|
| CreateNodePool |
|---|
|
在给定的项目和位置中创建一个新 NodePool。
|
| CreateVpnConnection |
|---|
|
在给定的项目和位置中创建新的 VPN 连接。
|
| DeleteCluster |
|---|
|
删除单个集群。
|
| DeleteNodePool |
|---|
|
删除单个 NodePool。
|
| DeleteVpnConnection |
|---|
|
删除单个 VPN 连接。
|
| GenerateAccessToken |
|---|
|
为集群生成访问令牌。
|
| GetCluster |
|---|
|
获取单个集群的详细信息。
|
| GetMachine |
|---|
|
获取单个虚拟机的详细信息。
|
| GetNodePool |
|---|
|
获取单个 NodePool 的详细信息。
|
| GetVpnConnection |
|---|
|
获取单个 VPN 连接的详细信息。
|
| ListClusters |
|---|
|
列出给定项目和位置中的集群。
|
| ListMachines |
|---|
|
列出给定项目和位置中的机器。
|
| ListNodePools |
|---|
|
列出给定项目和位置中的 NodePool。
|
| ListVpnConnections |
|---|
|
列出给定项目和位置中的 VPN 连接。
|
| UpdateCluster |
|---|
|
更新单个集群的参数。
|
| UpdateNodePool |
|---|
|
更新单个 NodePool 的参数。
|
授权
将由 GEC 应用和管理的 RBAC 政策。
| 字段 | |
|---|---|
admin_users |
必需。将被授予集群上 cluster-admin 角色的用户,向该用户提供对集群的完整访问权限。目前,这是一个单数字段,但未来将扩展为允许多个管理员。 |
集群
Google Distributed Cloud Edge Kubernetes 集群。
| 字段 | |
|---|---|
name |
必需。集群的资源名称。 |
create_time |
仅限输出。集群的创建时间。 |
update_time |
仅限输出。集群上次更新的时间。 |
labels |
与此资源关联的标签。 |
fleet |
可选。舰队配置。 |
networking |
必需。集群级网络配置。 |
authorization |
必需。不可变。将由 GEC 应用和管理的 RBAC 政策。 |
default_max_pods_per_node |
可选。如果没有为此集群中的节点池明确指定最大值,则系统会为每个节点使用的默认最大值。如果未指定,系统将使用 Kubernetes 默认值。 |
endpoint |
仅限输出。Kubernetes API 服务器的 IP 地址。 |
cluster_ca_certificate |
仅限输出。集群 CA 的 PEM 编码的公共证书。 |
maintenance_policy |
可选。集群范围的维护政策配置。 |
control_plane_version |
仅限输出。控制平面发布版本 |
node_version |
仅限输出。所有工作器节点中的最低发布版本。如果集群没有任何工作器节点,此字段可以为空。 |
ClusterNetworking
集群级网络配置。
| 字段 | |
|---|---|
cluster_ipv4_cidr_blocks[] |
必需。集群中的所有 pod 都会分配有这些块中的 RFC1918 IPv4 地址。仅支持单个块。此字段一经创建便无法更改。 |
services_ipv4_cidr_blocks[] |
必需。集群中的所有服务都会分配有这些块中的 RFC1918 IPv4 地址。仅支持单个块。此字段一经创建便无法更改。 |
ClusterUser
RBAC 政策的用户主账号。
| 字段 | |
|---|---|
username |
必需。有效的 Google 用户名。 |
CreateClusterRequest
创建集群。
| 字段 | |
|---|---|
parent |
必需。将在其中创建此集群的父级位置。 必须对指定的资源
|
cluster_id |
必需。由客户端指定的集群唯一标识符。 |
cluster |
必需。要创建的集群。 |
request_id |
相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 |
CreateNodePoolRequest
创建节点池。
| 字段 | |
|---|---|
parent |
必需。将在其中创建此节点池的父级集群。 必须对指定的资源
|
node_pool_id |
必需。节点池的客户端指定唯一标识符。 |
node_pool |
必需。要创建的节点池。 |
request_id |
相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 |
CreateVpnConnectionRequest
创建 VPN 连接。
| 字段 | |
|---|---|
parent |
必需。将在其中创建相应 VPN 连接的父级位置。 必须对指定的资源
|
vpn_connection_id |
必需。VPN 连接标识符。 |
vpn_connection |
必需。要创建的 VPN 连接。 |
request_id |
相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 |
DeleteClusterRequest
删除集群。
| 字段 | |
|---|---|
name |
必需。集群的资源名称。 必须对指定的资源
|
request_id |
相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 |
DeleteNodePoolRequest
删除节点池。
| 字段 | |
|---|---|
name |
必需。节点池的资源名称。 必须对指定的资源
|
request_id |
相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 |
DeleteVpnConnectionRequest
删除 VPN 连接。
| 字段 | |
|---|---|
name |
必需。VPN 连接的资源名称。 必须对指定的资源
|
request_id |
相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 |
舰队
与舰队相关的配置。
舰队是 Google Cloud 关于以逻辑方式整理集群的概念,让您可以使用和管理多集群功能,并在您的所有系统中应用一致的政策。
| 字段 | |
|---|---|
project |
必需。将在其中注册此集群的舰队宿主项目的名称。 项目名称的格式为 |
membership |
仅限输出。与此集群关联的托管式 Hub 成员资格资源的名称。 成员资格名称的格式为 |
GenerateAccessTokenRequest
为集群生成访问令牌。
| 字段 | |
|---|---|
cluster |
必需。集群的资源名称。 必须对指定的资源
|
GenerateAccessTokenResponse
集群的访问令牌。
| 字段 | |
|---|---|
access_token |
仅限输出。用于向 k8s api-server 进行身份验证的访问令牌。 |
expire_time |
仅限输出。令牌过期时的时间戳。 |
GetClusterRequest
获取集群。
| 字段 | |
|---|---|
name |
必需。集群的资源名称。 必须对指定的资源
|
GetMachineRequest
获取机器。
| 字段 | |
|---|---|
name |
必需。虚拟机的资源名称。 必须对指定的资源
|
GetNodePoolRequest
获取节点池。
| 字段 | |
|---|---|
name |
必需。节点池的资源名称。 必须对指定的资源
|
GetVpnConnectionRequest
获取 VPN 连接。
| 字段 | |
|---|---|
name |
必需。VPN 连接的资源名称。 必须对指定的资源
|
KmsKeyState
表示用于 CMEK 集成的客户管理的 KMS 密钥的可访问性状态。
| 枚举 | |
|---|---|
KMS_KEY_STATE_UNSPECIFIED |
未指定。 |
KMS_KEY_STATE_KEY_AVAILABLE |
密钥可供使用,并且应可访问依赖资源。 |
KMS_KEY_STATE_KEY_UNAVAILABLE |
密钥因不明原因而不可用。依赖资源可能无法访问。 |
ListClustersRequest
列出位置中的集群。
| 字段 | |
|---|---|
parent |
必需。拥有此集集群合的父级位置。 必须对指定的资源
|
page_size |
要列出的资源数量上限。 |
page_token |
从上一个列表请求收到的页面令牌。从上一个列表请求收到的页面令牌。 |
filter |
系统只会列出与此过滤条件匹配的资源。 |
order_by |
指定资源的列出顺序。 |
ListClustersResponse
某个位置的集群列表。
| 字段 | |
|---|---|
clusters[] |
相应位置的集群。 |
next_page_token |
用于检索下一页结果的令牌。 |
unreachable[] |
无法到达的位置。 |
ListMachinesRequest
列出网站中的机器。
| 字段 | |
|---|---|
parent |
必需。拥有此机器集合的父级网站。 必须对指定的资源
|
page_size |
要列出的资源数量上限。 |
page_token |
从上一个列表请求收到的页面令牌。 |
filter |
系统只会列出与此过滤条件匹配的资源。 |
order_by |
指定资源的列出顺序。 |
ListMachinesResponse
相应网站中的机器列表。
| 字段 | |
|---|---|
machines[] |
网站中的机器。 |
next_page_token |
用于检索下一页结果的令牌。 |
unreachable[] |
无法到达的位置。 |
ListNodePoolsRequest
列出集群中的节点池。
| 字段 | |
|---|---|
parent |
必需。拥有此节点池集合的父集群。 必须对指定的资源
|
page_size |
要列出的资源数量上限。 |
page_token |
从上一个列表请求收到的页面令牌。 |
filter |
系统只会列出与此过滤条件匹配的资源。 |
order_by |
指定资源的列出顺序。 |
ListNodePoolsResponse
集群中的节点池列表。
| 字段 | |
|---|---|
node_pools[] |
集群中的节点池。 |
next_page_token |
用于检索下一页结果的令牌。 |
unreachable[] |
无法到达的位置。 |
ListVpnConnectionsRequest
列出 VPN 连接。
| 字段 | |
|---|---|
parent |
必需。拥有此 VPN 连接集合的父级位置。 必须对指定的资源
|
page_size |
要列出的资源数量上限。 |
page_token |
从上一个列表请求收到的页面令牌。 |
filter |
系统只会列出与此过滤条件匹配的资源。 |
order_by |
指定资源的列出顺序。 |
ListVpnConnectionsResponse
列出某个位置的 VPN 连接。
| 字段 | |
|---|---|
vpn_connections[] |
相应位置中的 VpnConnection。 |
next_page_token |
用于检索下一页结果的令牌。 |
unreachable[] |
无法到达的位置。 |
LocationMetadata
给定 google.cloud.location.Location 的元数据。
| 字段 | |
|---|---|
available_zones |
相应位置中可用的 Google Distributed Cloud Edge 可用区集。该地图以每个区域的小写 ID 为键。 |
机器
能够充当 Kubernetes 节点的 Google Distributed Cloud Edge 机器。
| 字段 | |
|---|---|
name |
必需。虚拟机的资源名称。 |
create_time |
仅限输出。节点池的创建时间。 |
update_time |
仅限输出。节点池的上次更新时间。 |
labels |
与此资源关联的标签。 |
hosted_node |
相应机器负责托管的节点的规范资源名称,例如 projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node};如果相应机器未分配为节点,则为空。 对于托管在边缘机器上的控制平面节点,此方法将返回以下格式:“projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}”。 |
zone |
相应机器的 Google Distributed Cloud Edge 可用区。 |
version |
仅限输出。设备的软件版本。 |
disabled |
仅限输出。相应机器是否已停用。如果停用,机器将无法进入服务模式。 |
MaintenancePolicy
维护政策配置。
| 字段 | |
|---|---|
window |
指定可执行维护的维护窗口。 |
MaintenanceWindow
维护窗口配置
| 字段 | |
|---|---|
recurring_window |
周期性维护窗口的配置。 |
节点池
集群中具有相同配置和规范的一组 Kubernetes 节点。
| 字段 | |
|---|---|
name |
必需。节点池的资源名称。 |
create_time |
仅限输出。节点池的创建时间。 |
update_time |
仅限输出。节点池的上次更新时间。 |
labels |
与此资源关联的标签。 |
node_location |
要在其中创建此节点池的 Google Distributed Cloud Edge 地区的名称。例如: |
node_count |
必需。池中的节点数。 |
machine_filter |
只有与此过滤条件匹配的机器才能加入节点池。过滤语言接受“name= |
local_disk_encryption |
可选。本地磁盘加密选项。此字段仅在启用 CMEK 支持时使用。 |
node_version |
仅限输出。所有工作器节点中的最低发布版本。 |
LocalDiskEncryption
边缘机器本地磁盘加密的 CMEK 支持配置。
| 字段 | |
|---|---|
kms_key |
不可变。用于保护节点本地磁盘的 Cloud KMS 加密密钥,例如 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}。如果未指定,系统会改用 Google 管理的密钥。 |
kms_key_active_version |
仅限输出。当前用于保护节点本地磁盘的 Cloud KMS CryptoKeyVersion。仅在设置了 kms_key 的情况下适用。 |
kms_key_state |
仅限输出。Cloud KMS CryptoKey 的可用性。如果不是 |
kms_status |
仅限输出。使用此密钥时 Cloud KMS 返回的错误状态。仅当 |
OperationMetadata
Edge Container API 方法的长时间运行的操作元数据。
| 字段 | |
|---|---|
create_time |
操作的创建时间。 |
end_time |
操作完成运行的时间。 |
target |
由服务器定义的操作目标的资源路径。 |
verb |
操作执行的谓词。 |
status_message |
人类可读的操作状态(如果有)。 |
requested_cancellation |
标识用户是否已请求取消操作。已成功取消的操作具有 [Operation.error][] 值且 |
api_version |
用于启动操作的 API 版本。 |
warnings[] |
不会阻止操作,但仍包含相关信息供最终用户接收的警告。 |
配额
表示 Edge Container 资源的配额。
| 字段 | |
|---|---|
metric |
配额指标的名称。 |
limit |
相应指标的配额限制。 |
usage |
相应指标的当前使用情况。 |
RecurringTimeWindow
表示会重复出现的任意时间段。
| 字段 | |
|---|---|
window |
首次重复出现的窗口。 |
recurrence |
用于指定相应窗口重复方式的 RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3)。它们会在开始时间和结束时间之间持续显示。 |
TimeWindow
表示任意时间窗口。
| 字段 | |
|---|---|
start_time |
时间段首次开始的时间。 |
end_time |
窗口结束的时间。结束时间必须晚于开始时间。 |
UpdateClusterRequest
更新集群。
| 字段 | |
|---|---|
update_mask |
字段掩码用于指定更新要在集群资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果用户未提供掩码,则所有字段都将被覆盖。 |
cluster |
更新后的集群。 必须对指定的资源
|
request_id |
相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 |
UpdateNodePoolRequest
更新节点池。
| 字段 | |
|---|---|
update_mask |
字段掩码用于指定更新要在 NodePool 资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果用户未提供掩码,则所有字段都将被覆盖。 |
node_pool |
更新后的节点池。 必须对指定的资源
|
request_id |
相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 |
VpnConnection
VPN 连接。
| 字段 | |
|---|---|
name |
必需。VPN 连接的资源名称 |
create_time |
仅限输出。VPN 连接的创建时间。 |
update_time |
仅限输出。上次更新 VPN 连接的时间。 |
labels |
与此资源关联的标签。 |
nat_gateway_ip |
NAT 网关 IP 或 WAN IP 地址。如果客户有多个 NAT IP 地址,则需要配置 NAT,以便只有一个外部 IP 地址映射到 GMEC Anthos 集群。如果不使用 NAT,则为空。 |
bgp_routing_mode |
VPC 网络的动态路由模式, |
cluster |
要连接的规范集群名称。格式为 projects/{project}/locations/{location}/clusters/{cluster}。 |
vpc |
要连接的 VPC 的网络 ID。 |
vpc_project |
可选。VPC 网络的项目详细信息。如果 VPC 与集群项目位于不同的项目中,则必须提供此参数。 |
enable_high_availability |
相应 VPN 连接是否在集群端启用了高可用性。如果启用,在创建 VPN 连接时,我们将尝试使用 2 个 ANG 浮动 IP。 |
details |
仅限输出。已创建的连接的详细信息。 |
BgpRoutingMode
路由模式。
| 枚举 | |
|---|---|
BGP_ROUTING_MODE_UNSPECIFIED |
未知。 |
REGIONAL |
区域模式。 |
GLOBAL |
全球模式。 |
详细信息
已创建的连接的详细信息。
| 字段 | |
|---|---|
state |
相应连接的状态。 |
error |
错误消息。仅当 state=ERROR 时填充。 |
cloud_router |
Cloud Router 信息。 |
cloud_vpns[] |
每个连接都有多个 Cloud VPN 网关。 |
CloudRouter
Cloud Router 信息。
| 字段 | |
|---|---|
name |
关联的 Cloud Router 名称。 |
CloudVpn
Cloud VPN 信息。
| 字段 | |
|---|---|
gateway |
创建的 Cloud VPN 网关名称。 |
州
当前连接状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
未知。 |
STATE_CONNECTED |
已连接。 |
STATE_CONNECTING |
仍在连接。 |
STATE_ERROR |
出现错误。 |
VpcProject
VPC 网络的项目详细信息。
| 字段 | |
|---|---|
project_id |
要连接的 VPC 的项目。如果未指定,则与集群项目相同。 |
service_account |
可选。用户在 VPC 项目中配置的服务账号。它用于为 VPN 连接创建/删除 Cloud Router 和 Cloud HA VPN。如果在创建 VPN 连接期间/之后更改此 SA,您需要移除 |project_id| 中的 Cloud Router 和 Cloud VPN 资源。此 SA 的格式为 service-{project_number}@gcp-sa-edgecontainer.iam.gserviceaccount.com。 |
ZoneMetadata
Google Distributed Cloud Edge 可用区,边缘机器位于其中。
| 字段 | |
|---|---|
quota[] |
相应可用区中资源的配额。 |