Package google.cloud.edgecontainer.v1

索引

EdgeContainer

EdgeContainer API 用于管理 Google Edge Cloud 部署中的 Kubernetes 集群。

CreateCluster

rpc CreateCluster(CreateClusterRequest) returns (Operation)

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

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

CreateNodePool

rpc CreateNodePool(CreateNodePoolRequest) returns (Operation)

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

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

CreateVpnConnection

rpc CreateVpnConnection(CreateVpnConnectionRequest) returns (Operation)

在给定的项目和位置中创建新的 VPN 连接。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

DeleteCluster

rpc DeleteCluster(DeleteClusterRequest) returns (Operation)

删除单个集群。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

DeleteNodePool

rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation)

删除单个 NodePool。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

DeleteVpnConnection

rpc DeleteVpnConnection(DeleteVpnConnectionRequest) returns (Operation)

删除单个 VPN 连接。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

GenerateAccessToken

rpc GenerateAccessToken(GenerateAccessTokenRequest) returns (GenerateAccessTokenResponse)

为集群生成访问令牌。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

GetCluster

rpc GetCluster(GetClusterRequest) returns (Cluster)

获取单个集群的详细信息。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

GetMachine

rpc GetMachine(GetMachineRequest) returns (Machine)

获取单个虚拟机的详细信息。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

GetNodePool

rpc GetNodePool(GetNodePoolRequest) returns (NodePool)

获取单个 NodePool 的详细信息。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

GetVpnConnection

rpc GetVpnConnection(GetVpnConnectionRequest) returns (VpnConnection)

获取单个 VPN 连接的详细信息。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

ListClusters

rpc ListClusters(ListClustersRequest) returns (ListClustersResponse)

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

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

ListMachines

rpc ListMachines(ListMachinesRequest) returns (ListMachinesResponse)

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

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

ListNodePools

rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse)

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

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

ListVpnConnections

rpc ListVpnConnections(ListVpnConnectionsRequest) returns (ListVpnConnectionsResponse)

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

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

UpdateCluster

rpc UpdateCluster(UpdateClusterRequest) returns (Operation)

更新单个集群的参数。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

UpdateNodePool

rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation)

更新单个 NodePool 的参数。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览

授权

将由 GEC 应用和管理的 RBAC 政策。

字段
admin_users

ClusterUser

必需。将被授予集群上 cluster-admin 角色的用户,向该用户提供对集群的完整访问权限。目前,这是一个单数字段,但未来将扩展为允许多个管理员。

集群

Google Distributed Cloud Edge Kubernetes 集群。

字段
name

string

必需。集群的资源名称。

create_time

Timestamp

仅限输出。集群的创建时间。

update_time

Timestamp

仅限输出。集群上次更新的时间。

labels

map<string, string>

与此资源关联的标签。

fleet

Fleet

可选。舰队配置。

networking

ClusterNetworking

必需。集群级网络配置。

authorization

Authorization

必需。不可变。将由 GEC 应用和管理的 RBAC 政策。

default_max_pods_per_node

int32

可选。如果没有为此集群中的节点池明确指定最大值,则系统会为每个节点使用的默认最大值。如果未指定,系统将使用 Kubernetes 默认值。

endpoint

string

仅限输出。Kubernetes API 服务器的 IP 地址。

cluster_ca_certificate

string

仅限输出。集群 CA 的 PEM 编码的公共证书。

maintenance_policy

MaintenancePolicy

可选。集群范围的维护政策配置。

control_plane_version

string

仅限输出。控制平面发布版本

node_version

string

仅限输出。所有工作器节点中的最低发布版本。如果集群没有任何工作器节点,此字段可以为空。

ClusterNetworking

集群级网络配置。

字段
cluster_ipv4_cidr_blocks[]

string

必需。集群中的所有 pod 都会分配有这些块中的 RFC1918 IPv4 地址。仅支持单个块。此字段一经创建便无法更改。

services_ipv4_cidr_blocks[]

string

必需。集群中的所有服务都会分配有这些块中的 RFC1918 IPv4 地址。仅支持单个块。此字段一经创建便无法更改。

ClusterUser

RBAC 政策的用户主账号。

字段
username

string

必需。有效的 Google 用户名。

CreateClusterRequest

创建集群。

字段
parent

string

必需。将在其中创建此集群的父级位置。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • edgecontainer.clusters.create
cluster_id

string

必需。由客户端指定的集群唯一标识符。

cluster

Cluster

必需。要创建的集群。

request_id

string

相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时,此请求才是幂等的。

CreateNodePoolRequest

创建节点池。

字段
parent

string

必需。将在其中创建此节点池的父级集群。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • edgecontainer.nodePools.create
node_pool_id

string

必需。节点池的客户端指定唯一标识符。

node_pool

NodePool

必需。要创建的节点池。

request_id

string

相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时,此请求才是幂等的。

CreateVpnConnectionRequest

创建 VPN 连接。

字段
parent

string

必需。将在其中创建相应 VPN 连接的父级位置。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • edgecontainer.vpnConnections.create
vpn_connection_id

string

必需。VPN 连接标识符。

vpn_connection

VpnConnection

必需。要创建的 VPN 连接。

request_id

string

相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时,此请求才是幂等的。

DeleteClusterRequest

删除集群。

字段
name

string

必需。集群的资源名称。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • edgecontainer.clusters.delete
request_id

string

相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时,此请求才是幂等的。

DeleteNodePoolRequest

删除节点池。

字段
name

string

必需。节点池的资源名称。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • edgecontainer.nodePools.delete
request_id

string

相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时,此请求才是幂等的。

DeleteVpnConnectionRequest

删除 VPN 连接。

字段
name

string

必需。VPN 连接的资源名称。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • edgecontainer.vpnConnections.delete
request_id

string

相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时,此请求才是幂等的。

舰队

与舰队相关的配置。

舰队是 Google Cloud 关于以逻辑方式整理集群的概念,让您可以使用和管理多集群功能,并在您的所有系统中应用一致的政策。

字段
project

string

必需。将在其中注册此集群的舰队宿主项目的名称。

项目名称的格式为 projects/<project-number>

membership

string

仅限输出。与此集群关联的托管式 Hub 成员资格资源的名称。

成员资格名称的格式为 projects/<project-number>/locations/global/membership/<cluster-id>

GenerateAccessTokenRequest

为集群生成访问令牌。

字段
cluster

string

必需。集群的资源名称。

必须对指定的资源 cluster 具有以下 IAM 权限才能进行授权:

  • edgecontainer.clusters.get

GenerateAccessTokenResponse

集群的访问令牌。

字段
access_token

string

仅限输出。用于向 k8s api-server 进行身份验证的访问令牌。

expire_time

Timestamp

仅限输出。令牌过期时的时间戳。

GetClusterRequest

获取集群。

字段
name

string

必需。集群的资源名称。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • edgecontainer.clusters.get

GetMachineRequest

获取机器。

字段
name

string

必需。虚拟机的资源名称。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • edgecontainer.machines.get

GetNodePoolRequest

获取节点池。

字段
name

string

必需。节点池的资源名称。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • edgecontainer.nodePools.get

GetVpnConnectionRequest

获取 VPN 连接。

字段
name

string

必需。VPN 连接的资源名称。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • edgecontainer.vpnConnections.get

KmsKeyState

表示用于 CMEK 集成的客户管理的 KMS 密钥的可访问性状态。

枚举
KMS_KEY_STATE_UNSPECIFIED 未指定。
KMS_KEY_STATE_KEY_AVAILABLE 密钥可供使用,并且应可访问依赖资源。
KMS_KEY_STATE_KEY_UNAVAILABLE 密钥因不明原因而不可用。依赖资源可能无法访问。

ListClustersRequest

列出位置中的集群。

字段
parent

string

必需。拥有此集集群合的父级位置。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • edgecontainer.clusters.list
page_size

int32

要列出的资源数量上限。

page_token

string

从上一个列表请求收到的页面令牌。从上一个列表请求收到的页面令牌。

filter

string

系统只会列出与此过滤条件匹配的资源。

order_by

string

指定资源的列出顺序。

ListClustersResponse

某个位置的集群列表。

字段
clusters[]

Cluster

相应位置的集群。

next_page_token

string

用于检索下一页结果的令牌。

unreachable[]

string

无法到达的位置。

ListMachinesRequest

列出网站中的机器。

字段
parent

string

必需。拥有此机器集合的父级网站。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • edgecontainer.machines.list
page_size

int32

要列出的资源数量上限。

page_token

string

从上一个列表请求收到的页面令牌。

filter

string

系统只会列出与此过滤条件匹配的资源。

order_by

string

指定资源的列出顺序。

ListMachinesResponse

相应网站中的机器列表。

字段
machines[]

Machine

网站中的机器。

next_page_token

string

用于检索下一页结果的令牌。

unreachable[]

string

无法到达的位置。

ListNodePoolsRequest

列出集群中的节点池。

字段
parent

string

必需。拥有此节点池集合的父集群。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • edgecontainer.nodePools.list
page_size

int32

要列出的资源数量上限。

page_token

string

从上一个列表请求收到的页面令牌。

filter

string

系统只会列出与此过滤条件匹配的资源。

order_by

string

指定资源的列出顺序。

ListNodePoolsResponse

集群中的节点池列表。

字段
node_pools[]

NodePool

集群中的节点池。

next_page_token

string

用于检索下一页结果的令牌。

unreachable[]

string

无法到达的位置。

ListVpnConnectionsRequest

列出 VPN 连接。

字段
parent

string

必需。拥有此 VPN 连接集合的父级位置。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • edgecontainer.vpnConnections.list
page_size

int32

要列出的资源数量上限。

page_token

string

从上一个列表请求收到的页面令牌。

filter

string

系统只会列出与此过滤条件匹配的资源。

order_by

string

指定资源的列出顺序。

ListVpnConnectionsResponse

列出某个位置的 VPN 连接。

字段
vpn_connections[]

VpnConnection

相应位置中的 VpnConnection。

next_page_token

string

用于检索下一页结果的令牌。

unreachable[]

string

无法到达的位置。

LocationMetadata

给定 google.cloud.location.Location 的元数据。

字段
available_zones

map<string, ZoneMetadata>

相应位置中可用的 Google Distributed Cloud Edge 可用区集。该地图以每个区域的小写 ID 为键。

机器

能够充当 Kubernetes 节点的 Google Distributed Cloud Edge 机器。

字段
name

string

必需。虚拟机的资源名称。

create_time

Timestamp

仅限输出。节点池的创建时间。

update_time

Timestamp

仅限输出。节点池的上次更新时间。

labels

map<string, string>

与此资源关联的标签。

hosted_node

string

相应机器负责托管的节点的规范资源名称,例如 projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node};如果相应机器未分配为节点,则为空。

对于托管在边缘机器上的控制平面节点,此方法将返回以下格式:“projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}”。

zone

string

相应机器的 Google Distributed Cloud Edge 可用区。

version

string

仅限输出。设备的软件版本。

disabled

bool

仅限输出。相应机器是否已停用。如果停用,机器将无法进入服务模式。

MaintenancePolicy

维护政策配置。

字段
window

MaintenanceWindow

指定可执行维护的维护窗口。

MaintenanceWindow

维护窗口配置

字段
recurring_window

RecurringTimeWindow

周期性维护窗口的配置。

节点池

集群中具有相同配置和规范的一组 Kubernetes 节点。

字段
name

string

必需。节点池的资源名称。

create_time

Timestamp

仅限输出。节点池的创建时间。

update_time

Timestamp

仅限输出。节点池的上次更新时间。

labels

map<string, string>

与此资源关联的标签。

node_location

string

要在其中创建此节点池的 Google Distributed Cloud Edge 地区的名称。例如:us-central1-edge-customer-a

node_count

int32

必需。池中的节点数。

machine_filter

string

只有与此过滤条件匹配的机器才能加入节点池。过滤语言接受“name=”等字符串,AIP-160 中对此进行了更详细的说明。

local_disk_encryption

LocalDiskEncryption

可选。本地磁盘加密选项。此字段仅在启用 CMEK 支持时使用。

node_version

string

仅限输出。所有工作器节点中的最低发布版本。

LocalDiskEncryption

边缘机器本地磁盘加密的 CMEK 支持配置。

字段
kms_key

string

不可变。用于保护节点本地磁盘的 Cloud KMS 加密密钥,例如 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}。如果未指定,系统会改用 Google 管理的密钥。

kms_key_active_version

string

仅限输出。当前用于保护节点本地磁盘的 Cloud KMS CryptoKeyVersion。仅在设置了 kms_key 的情况下适用。

kms_key_state

KmsKeyState

仅限输出。Cloud KMS CryptoKey 的可用性。如果不是 KEY_AVAILABLE,节点可能会因无法访问其本地数据而离线。这可能是因为缺少使用密钥的权限,或者密钥已停用或删除。

kms_status

Status

仅限输出。使用此密钥时 Cloud KMS 返回的错误状态。仅当 kms_key_state 不为 KMS_KEY_STATE_KEY_AVAILABLE 时,系统才会填充此字段。如果填充,此字段包含 Cloud KMS 报告的错误状态。

OperationMetadata

Edge Container API 方法的长时间运行的操作元数据。

字段
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 版本。

warnings[]

string

不会阻止操作,但仍包含相关信息供最终用户接收的警告。

配额

表示 Edge Container 资源的配额。

字段
metric

string

配额指标的名称。

limit

double

相应指标的配额限制。

usage

double

相应指标的当前使用情况。

RecurringTimeWindow

表示会重复出现的任意时间段。

字段
window

TimeWindow

首次重复出现的窗口。

recurrence

string

用于指定相应窗口重复方式的 RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3)。它们会在开始时间和结束时间之间持续显示。

TimeWindow

表示任意时间窗口。

字段
start_time

Timestamp

时间段首次开始的时间。

end_time

Timestamp

窗口结束的时间。结束时间必须晚于开始时间。

UpdateClusterRequest

更新集群。

字段
update_mask

FieldMask

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

cluster

Cluster

更新后的集群。

必须对指定的资源 cluster 具有以下 IAM 权限才能进行授权:

  • edgecontainer.clusters.update
request_id

string

相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时,此请求才是幂等的。

UpdateNodePoolRequest

更新节点池。

字段
update_mask

FieldMask

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

node_pool

NodePool

更新后的节点池。

必须对指定的资源 nodePool 具有以下 IAM 权限才能进行授权:

  • edgecontainer.nodePools.update
request_id

string

相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时,此请求才是幂等的。

VpnConnection

VPN 连接。

字段
name

string

必需。VPN 连接的资源名称

create_time

Timestamp

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

update_time

Timestamp

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

labels

map<string, string>

与此资源关联的标签。

nat_gateway_ip

string

NAT 网关 IP 或 WAN IP 地址。如果客户有多个 NAT IP 地址,则需要配置 NAT,以便只有一个外部 IP 地址映射到 GMEC Anthos 集群。如果不使用 NAT,则为空。

bgp_routing_mode
(deprecated)

BgpRoutingMode

VPC 网络的动态路由模式,regionalglobal

cluster

string

要连接的规范集群名称。格式为 projects/{project}/locations/{location}/clusters/{cluster}。

vpc

string

要连接的 VPC 的网络 ID。

vpc_project

VpcProject

可选。VPC 网络的项目详细信息。如果 VPC 与集群项目位于不同的项目中,则必须提供此参数。

enable_high_availability

bool

相应 VPN 连接是否在集群端启用了高可用性。如果启用,在创建 VPN 连接时,我们将尝试使用 2 个 ANG 浮动 IP。

details

Details

仅限输出。已创建的连接的详细信息。

BgpRoutingMode

路由模式。

枚举
BGP_ROUTING_MODE_UNSPECIFIED 未知。
REGIONAL 区域模式。
GLOBAL 全球模式。

详细信息

已创建的连接的详细信息。

字段
state

State

相应连接的状态。

error

string

错误消息。仅当 state=ERROR 时填充。

cloud_router

CloudRouter

Cloud Router 信息。

cloud_vpns[]

CloudVpn

每个连接都有多个 Cloud VPN 网关。

CloudRouter

Cloud Router 信息。

字段
name

string

关联的 Cloud Router 名称。

CloudVpn

Cloud VPN 信息。

字段
gateway

string

创建的 Cloud VPN 网关名称。

当前连接状态。

枚举
STATE_UNSPECIFIED 未知。
STATE_CONNECTED 已连接。
STATE_CONNECTING 仍在连接。
STATE_ERROR 出现错误。

VpcProject

VPC 网络的项目详细信息。

字段
project_id

string

要连接的 VPC 的项目。如果未指定,则与集群项目相同。

service_account
(deprecated)

string

可选。用户在 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[]

Quota

相应可用区中资源的配额。