Package google.cloud.edgecontainer.v1alpha

索引

• EdgeContainer（接口）
• ApiKey（消息）
• ApiKey.ApiTarget（消息）
• ApiKey.State（枚举）
• Authorization（消息）
• ChannelConfig（消息）
• Cluster（消息）
• Cluster.ConnectionState（消息）
• Cluster.ConnectionState.State（枚举）
• Cluster.ContainerRuntimeConfig（消息）
• Cluster.ContainerRuntimeConfig.DefaultContainerRuntime（枚举）
• Cluster.ControlPlane（消息）
• Cluster.ControlPlane.Local（消息）
• Cluster.ControlPlane.Remote（消息）
• Cluster.ControlPlane.SharedDeploymentPolicy（枚举）
• Cluster.ControlPlaneEncryption（消息）
• Cluster.ExternalLoadBalancerPool（消息）
• Cluster.GoogleGroupAuthenticationConfig（消息）
• Cluster.MaintenanceEvent（消息）
• Cluster.MaintenanceEvent.Schedule（枚举）
• Cluster.MaintenanceEvent.State（枚举）
• Cluster.MaintenanceEvent.Type（枚举）
• Cluster.ReleaseChannel（枚举）
• Cluster.Status（枚举）
• Cluster.SurvivabilityConfig（消息）
• Cluster.SystemAddonsConfig（消息）
• Cluster.SystemAddonsConfig.Ingress（消息）
• Cluster.SystemAddonsConfig.VMServiceConfig（消息）
• Cluster.ZoneStorageEncryption（消息）
• ClusterNetworking（消息）
• ClusterUser（消息）
• ConfigData（消息）
• CreateClusterRequest（消息）
• CreateIdentityProviderRequest（消息）
• CreateNodePoolRequest（消息）
• CreateServiceAccountRequest（消息）
• CreateVpnConnectionRequest（消息）
• DeleteApiKeyRequest（消息）
• DeleteClusterRequest（消息）
• DeleteIdentityProviderRequest（消息）
• DeleteNodePoolRequest（消息）
• DeleteServiceAccountRequest（消息）
• DeleteVpnConnectionRequest（消息）
• EnableZonalProjectRequest（消息）
• EnableZonalProjectResponse（消息）
• EnableZonalServiceRequest（消息）
• Fleet（消息）
• GenerateAccessTokenRequest（消息）
• GenerateAccessTokenResponse（消息）
• GenerateOfflineCredentialRequest（消息）
• GenerateOfflineCredentialResponse（消息）
• GenerateServiceAccountKeyRequest（消息）
• GenerateServiceAccountKeyResponse（消息）
• GetApiKeyRequest（消息）
• GetClusterRequest（消息）
• GetIamPolicyRequest（消息）
• GetIdentityProviderRequest（消息）
• GetMachineRequest（消息）
• GetNodePoolRequest（消息）
• GetServerConfigRequest（消息）
• GetServiceAccountRequest（消息）
• GetVpnConnectionRequest（消息）
• GetZonalProjectRequest（消息）
• GetZonalServiceRequest（消息）
• GetZoneRequest（消息）
• IamPolicy（消息）
• IamPolicy.Binding（消息）
• IamPolicy.Principal（消息）
• IdentityProvider（消息）
• KmsKeyState（枚举）
• ListApiKeysRequest（消息）
• ListApiKeysResponse（消息）
• ListClustersRequest（消息）
• ListClustersResponse（消息）
• ListIdentityProvidersRequest（消息）
• ListIdentityProvidersResponse（消息）
• ListMachinesRequest（消息）
• ListMachinesResponse（消息）
• ListNodePoolsRequest（消息）
• ListNodePoolsResponse（消息）
• ListServiceAccountsRequest（消息）
• ListServiceAccountsResponse（消息）
• ListVpnConnectionsRequest（消息）
• ListVpnConnectionsResponse（消息）
• ListZonalProjectsRequest（消息）
• ListZonalProjectsResponse（消息）
• ListZonalServicesRequest（消息）
• ListZonalServicesResponse（消息）
• ListZonesRequest（消息）
• ListZonesResponse（消息）
• LocationMetadata（消息）
• Machine（消息）
• Machine.Purpose（枚举）
• Machine.Status（枚举）
• MaintenanceExclusionWindow（消息）
• MaintenancePolicy（消息）
• MaintenanceWindow（消息）
• NodePool（消息）
• NodePool.LocalDiskEncryption（消息）
• NodePool.NodeConfig（消息）
• OIDCProviderConfig（消息）
• OperationMetadata（消息）
• OperationMetadata.StatusReason（枚举）
• Quota（消息）
• RecurringTimeWindow（消息）
• ResourceState（枚举）
• SAMLProviderConfig（消息）
• ServerConfig（消息）
• ServiceAccount（消息）
• ServiceAccount.State（枚举）
• SetIamPolicyRequest（消息）
• SystemPartitionGiBSize（枚举）
• TimeWindow（消息）
• UpdateClusterRequest（消息）
• UpdateNodePoolRequest（消息）
• UpgradeClusterRequest（消息）
• UpgradeClusterRequest.Schedule（枚举）
• Version（消息）
• VersionRollout（消息）
• VpnConnection（消息）
• VpnConnection.BgpRoutingMode（枚举）
• VpnConnection.Details（消息）
• VpnConnection.Details.CloudRouter（消息）
• VpnConnection.Details.CloudVpn（消息）
• VpnConnection.Details.State（枚举）
• VpnConnection.VpcProject（消息）
• ZonalProject（消息）
• ZonalProject.State（枚举）
• ZonalService（消息）
• ZonalService.ServiceSelector（枚举）
• ZonalService.State（枚举）
• Zone（消息）
• Zone.DNSServer（消息）
• Zone.State（枚举）
• ZoneMetadata（消息）
• ZoneMetadata.RackType（枚举）

EdgeContainer

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

CreateCluster
rpc CreateCluster(CreateClusterRequest) returns (Operation) 在给定的项目和位置中创建新的集群。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateIdentityProvider
rpc CreateIdentityProvider(CreateIdentityProviderRequest) returns (Operation) 在基础架构集群中配置身份提供方。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateNodePool
rpc CreateNodePool(CreateNodePoolRequest) returns (Operation) 在给定的项目和位置中创建一个新 NodePool。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateServiceAccount
rpc CreateServiceAccount(CreateServiceAccountRequest) returns (Operation) CreateServiceAccount 会在集群的项目命名空间中创建项目服务账号 CR（对于 V2，为基础架构集群；对于 V1，为用户集群）。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateVpnConnection
rpc CreateVpnConnection(CreateVpnConnectionRequest) returns (Operation) 在给定的项目和位置中创建新的 VPN 连接。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteApiKey
rpc DeleteApiKey(DeleteApiKeyRequest) returns (Operation) DeleteApiKey 会删除指定项目服务账号的 API 密钥。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteCluster
rpc DeleteCluster(DeleteClusterRequest) returns (Operation) 删除单个集群。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteIdentityProvider
rpc DeleteIdentityProvider(DeleteIdentityProviderRequest) returns (Operation) DeleteIdentityProvider 会从基础架构集群中移除身份提供方。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteNodePool
rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation) 删除单个 NodePool。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteServiceAccount
rpc DeleteServiceAccount(DeleteServiceAccountRequest) returns (Operation) DeleteServiceAccount 会删除集群（V2 为基础架构集群，V1 为用户集群）的项目命名空间中的项目服务账号 CR。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteVpnConnection
rpc DeleteVpnConnection(DeleteVpnConnectionRequest) returns (Operation) 删除单个 VPN 连接。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

EnableZonalProject
rpc EnableZonalProject(EnableZonalProjectRequest) returns (Operation) EnableZonalProject 可在可用区中启用使用方项目。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

EnableZonalService
rpc EnableZonalService(EnableZonalServiceRequest) returns (Operation) EnableZonalService 可在区域中启用服务。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GenerateAccessToken
rpc GenerateAccessToken(GenerateAccessTokenRequest) returns (GenerateAccessTokenResponse) 为集群生成访问令牌。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GenerateOfflineCredential
rpc GenerateOfflineCredential(GenerateOfflineCredentialRequest) returns (GenerateOfflineCredentialResponse) 为集群生成离线凭据。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GenerateServiceAccountKey
rpc GenerateServiceAccountKey(GenerateServiceAccountKeyRequest) returns (GenerateServiceAccountKeyResponse) GenerateServiceAccountKey 会为指定的服务账号资源生成密钥对。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetApiKey
rpc GetApiKey(GetApiKeyRequest) returns (ApiKey) 获取单个 API 密钥的详细信息。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetCluster
rpc GetCluster(GetClusterRequest) returns (Cluster) 获取单个集群的详细信息。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetIamPolicy
rpc GetIamPolicy(GetIamPolicyRequest) returns (IamPolicy) GetIamPolicy 可获取基础架构集群中项目的 IAM 政策。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetIdentityProvider
rpc GetIdentityProvider(GetIdentityProviderRequest) returns (IdentityProvider) GetIdentityProvider 用于获取身份提供方的详细信息。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetMachine
rpc GetMachine(GetMachineRequest) returns (Machine) 获取单个虚拟机的详细信息。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetNodePool
rpc GetNodePool(GetNodePoolRequest) returns (NodePool) 获取单个 NodePool 的详细信息。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetServerConfig
rpc GetServerConfig(GetServerConfigRequest) returns (ServerConfig) 获取服务器配置。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetServiceAccount
rpc GetServiceAccount(GetServiceAccountRequest) returns (ServiceAccount) GetServiceAccount 用于获取服务账号详情。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetVpnConnection
rpc GetVpnConnection(GetVpnConnectionRequest) returns (VpnConnection) 获取单个 VPN 连接的详细信息。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetZonalProject
rpc GetZonalProject(GetZonalProjectRequest) returns (ZonalProject) GetZonalProject 会获取 ZonalProject。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetZonalService
rpc GetZonalService(GetZonalServiceRequest) returns (ZonalService) GetEnabledZonalService 可获取已启用服务的详细信息。 授权范围 需要以下 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。

ListApiKeys
rpc ListApiKeys(ListApiKeysRequest) returns (ListApiKeysResponse) 列出给定项目和位置中的 ApiKey。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListClusters
rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) 列出给定项目和位置中的集群。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListIdentityProviders
rpc ListIdentityProviders(ListIdentityProvidersRequest) returns (ListIdentityProvidersResponse) 列出基础架构集群中配置的身份提供方。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListMachines
rpc ListMachines(ListMachinesRequest) returns (ListMachinesResponse) 列出给定项目和位置中的机器。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListNodePools
rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse) 列出给定项目和位置中的 NodePool。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListServiceAccounts
rpc ListServiceAccounts(ListServiceAccountsRequest) returns (ListServiceAccountsResponse) ListServiceAccounts 会列出集群中项目的所有服务账号资源（对于 V2，为基础架构集群；对于 V1，为用户集群）的详细信息。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListVpnConnections
rpc ListVpnConnections(ListVpnConnectionsRequest) returns (ListVpnConnectionsResponse) 列出给定项目和位置中的 VPN 连接。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListZonalProjects
rpc ListZonalProjects(ListZonalProjectsRequest) returns (ListZonalProjectsResponse) 列出可用区中的 ZonalProjects。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListZonalServices
rpc ListZonalServices(ListZonalServicesRequest) returns (ListZonalServicesResponse) 列出给定项目和位置中的 ZonalService。 授权范围 需要以下 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。

SetIamPolicy
rpc SetIamPolicy(SetIamPolicyRequest) returns (IamPolicy) SetIamPolicy 用于为基础架构集群中的项目设置 IAM 政策。它会使用提供的政策覆盖现有政策。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

UpdateCluster
rpc UpdateCluster(UpdateClusterRequest) returns (Operation) 更新单个集群的参数。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

UpdateNodePool
rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation) 更新单个 NodePool 的参数。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

UpgradeCluster
rpc UpgradeCluster(UpgradeClusterRequest) returns (Operation) 升级单个集群。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ApiKey

表示 API 密钥资源。

字段
name	string 标识符。API 密钥的规范资源名称。例如：projects/{project}/locations/{location}/apiKeys/{api_key}
service_account_name	string 必需。与 API 密钥关联的服务账号的规范资源名称。
zone	string 必需。项目服务账号必须创建到的可用区的可用区 ID。
validity	Duration 可选。仅限输入。API 密钥的有效时长。
api_targets[]	ApiTarget 可选。API 密钥受限的 API 目标平台。如果为空，则允许使用所有 API。
labels	map<string, string> 可选。与此资源关联的标签。
key	string 仅限输出。APIKey CR 状态中的 apikey 字符串。
expire_time	Timestamp 仅限输出。根据 key_generation_time 和有效时长设置
state	State 仅限输出。集群中 API 密钥 CR 的状态。
reason	string 仅限输出。APIKey CR 状态的原因。
create_time	Timestamp 仅限输出。生成 API 密钥的时间。
delete_time	Timestamp 仅限输出。API 密钥资源被删除的时间。
update_time	Timestamp 仅限输出。API 密钥资源上次更新的时间。

ApiTarget

表示对 API 密钥的限制。由用户作为输入提供。

字段
service	string 可选。服务的 FQDN（在 API 调用中针对 req.Host 进行检查）。
methods[]	string 可选。遵循 gcp apitarget 限制中的规则，支持通配符。如果为空，则允许所有方法。

州

集群中 API 密钥的状态。

枚举
STATE_UNKNOWN	如果尚未运行协调，则状态未知。
ACTIVE	密钥处于有效状态，可用于身份验证。
NOT_ACTIVE	密钥处于无效状态，无法用于身份验证。如果密钥已过期、服务账号未处于有效状态或发生了内部错误，就可能会出现这种情况。

授权

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

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

ChannelConfig

发布渠道的配置。

字段
default_version	string 仅限输出。相应发布渠道的默认版本，例如：“1.4.0”。

集群

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 地址。
port	int32 仅限输出。Kubernetes API 服务器的端口号。
cluster_ca_certificate	string 仅限输出。集群 CA 的 PEM 编码的公共证书。
maintenance_policy	MaintenancePolicy 可选。集群范围的维护政策配置。
control_plane_version	string 仅限输出。控制平面发布版本
node_version	string 仅限输出。所有工作器节点中的最低发布版本。如果集群没有任何工作器节点，此字段可以为空。
control_plane	ControlPlane 可选。集群控制平面的配置。
system_addons_config	SystemAddonsConfig 可选。系统插件的配置。
external_load_balancer_ipv4_address_pools[]	string 可选。用于集群数据平面外部负载均衡的 IPv4 地址池。
control_plane_encryption	ControlPlaneEncryption 可选。远程控制平面磁盘加密选项。此字段仅在启用 CMEK 支持时使用。
status	Status 仅限输出。集群的当前状态。
maintenance_events[]	MaintenanceEvent 仅限输出。为集群安排的所有维护事件，包括正在进行的、计划在未来进行的以及过去（最多 90 天）完成的维护事件。
target_version	string 可选。目标集群版本。例如：“1.5.0”。
release_channel	ReleaseChannel 可选。集群订阅的发布渠道。
survivability_config	SurvivabilityConfig 可选。集群可维护性的配置，例如在网络连接断开的情况下。注意：这仅适用于本地控制平面集群。
external_load_balancer_ipv6_address_pools[]	string 可选。用于集群数据平面外部负载均衡的 IPv6 地址池。
connection_state	ConnectionState 仅限输出。集群的当前连接状态。
external_load_balancer_address_pools[]	ExternalLoadBalancerPool 可选。集群的外部负载均衡器池。
zone_storage_encryption	ZoneStorageEncryption 可选。可用区存储加密配置
container_runtime_config	ContainerRuntimeConfig 可选。集群的容器运行时配置。
enable_remote_backup	bool 可选。如果为 true，则会为此集群启用远程备份/恢复功能。
enable_cluster_isolation	bool 可选。表示是否需要隔离集群。go/cluster-isolation-in-gdcc-cluster
google_group_authentication	GoogleGroupAuthenticationConfig 可选。集群的 Google 群组身份验证配置。

ConnectionState

ConnectionState 用于保存从集群到 Google 的当前连接状态。

字段
state	State 仅限输出。当前连接状态。
update_time	Timestamp 仅限输出。连接状态上次更改的时间。

州

连接状态。

枚举
STATE_UNSPECIFIED	连接状态未知。
DISCONNECTED	此集群目前已与 Google 断开连接。
CONNECTED	此集群目前已连接到 Google。
CONNECTED_AND_SYNCING	此集群目前已连接到 Google，但可能最近在断开连接后重新连接。仍在同步回。

ContainerRuntimeConfig

集群的容器运行时配置。

字段
default_container_runtime	DefaultContainerRuntime 可选。要在集群中配置的默认容器运行时。

DefaultContainerRuntime

支持的容器运行时列表。

枚举
DEFAULT_CONTAINER_RUNTIME_UNSPECIFIED	未指定容器运行时。
RUNC	使用 runc 作为集群中的默认容器运行时。
GVISOR	将 gVisor 用作集群中的默认容器运行时。

ControlPlane

集群控制平面的配置。

字段
联合字段 config。 config 只能是下列其中一项：
remote	Remote 远程控制平面配置。
local	Local 本地控制平面配置。 警告：本地控制平面集群必须在自己的项目中创建。本地控制平面集群不能与任何其他类型的集群（包括非 GDCE 集群）共存于同一项目中。在同一项目中将本地控制平面 GDCE 集群与任何其他类型的集群混合使用可能会导致数据丢失。

本地

特定于控制平面本地托管的集群的配置。

警告：本地控制平面集群必须在自己的项目中创建。本地控制平面集群不能与任何其他类型的集群（包括非 GDCE 集群）共存于同一项目中。在同一项目中将本地控制平面 GDCE 集群与任何其他类型的集群混合使用可能会导致数据丢失。

字段
node_location	string 要在其中创建此节点池的 Google Distributed Cloud Edge 可用区的名称。例如：us-central1-edge-customer-a。
node_count	int32 用作控制平面副本的节点数量。
machine_filter	string 只有与此过滤条件匹配的机器才能托管控制平面节点。过滤语言接受“name=”等字符串，相关文档请参阅 AIP-160。
shared_deployment_policy	SharedDeploymentPolicy 有关如何部署用户应用的政策配置。
control_plane_node_storage_schema	string 可选。控制平面节点的存储架构的名称。
control_plane_node_system_partition_size	SystemPartitionGiBSize 可选。控制平面节点的系统分区大小（以 GiB 为单位）。

远程

此类型没有字段。

特定于控制平面远程托管的集群的配置。

SharedDeploymentPolicy

表示有关如何部署用户应用的政策配置。

枚举
SHARED_DEPLOYMENT_POLICY_UNSPECIFIED	未指定。
ALLOWED	用户应用可以部署在控制平面和工作器节点上。
DISALLOWED	用户应用无法部署在控制平面节点上，只能部署在工作器节点上。

ControlPlaneEncryption

控制平面节点对客户管理的 KMS 密钥的支持的配置。

字段
kms_key	string 可选。用于保护控制平面磁盘的 Cloud KMS CryptoKey，例如 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 报告的错误状态。
resource_state	ResourceState 仅限输出。与 CMEK 关联的当前资源状态。

ExternalLoadBalancerPool

具有自定义配置（例如名称、手动/自动分配、不重叠的 IPv4 和可选的 IPv6 地址范围）的外部负载均衡器池。

字段
address_pool	string 可选。外部负载均衡器池的名称。
ipv4_range[]	string 必需。外部负载均衡器池的不重叠 IPv4 地址范围。
ipv6_range[]	string 可选。外部负载均衡器池的非重叠 IPv6 地址范围。
avoid_buggy_ips	bool 可选。如果为 true，则池会忽略以 .0 和 .255 结尾的 IP 地址。某些网络硬件会丢弃流向这些特殊地址的流量。其默认值为 false。
manual_assign	bool 可选。如果值为 true，则此池中的地址不会自动分配给 Kubernetes 服务。如果为 true，则只有在服务明确指定时，才使用此池中的 IP 地址。其默认值为 false。

GoogleGroupAuthenticationConfig

集群的 Google 群组身份验证配置。go/gdc-google-group-authentication

字段
enable	bool 可选。如果为 true，则集群将配置为使用 Google 群组身份验证。

MaintenanceEvent

维护事件是指可能会暂时中断集群工作负载的操作，包括 Google 驱动或用户发起的集群升级、用户发起的需要重启节点的集群配置更改等。

字段
uuid	string 仅限输出。维护事件的 UUID。
target_version	string 仅限输出。集群的目标版本。
operation	string 仅限输出。用于运行维护事件的操作。采用 projects/*/locations/*/operations/* 格式。如果维护事件分为多个操作（例如，由于维护窗口），系统会记录最新的操作。
type	Type 仅限输出。维护事件的类型。
schedule	Schedule 仅限输出。维护事件的安排。
state	State 仅限输出。维护事件的状态。
create_time	Timestamp 仅限输出。维护事件请求的创建时间。
start_time	Timestamp 仅限输出。维护事件的开始时间。
end_time	Timestamp 仅限输出。维护事件结束的时间，无论成功与否。如果维护事件分为多个维护窗口，则只有在整个流程结束时才会更新 end_time。
update_time	Timestamp 仅限输出。维护事件消息的更新时间。

时间表

指明应何时执行维护事件。

枚举
SCHEDULE_UNSPECIFIED	未指定。
IMMEDIATELY	收到请求后立即执行。

州

表示维护事件状态。

枚举
STATE_UNSPECIFIED	未指定。
RECONCILING	维护事件正在进行中。该集群可能无法使用。
SUCCEEDED	维护事件成功。
FAILED	维护事件失败。

类型

表示维护事件类型。

枚举
TYPE_UNSPECIFIED	未指定。
USER_INITIATED_UPGRADE	由用户发起的升级。
GOOGLE_DRIVEN_UPGRADE	由 Google 推动的升级。

ReleaseChannel

集群订阅的发布渠道。

枚举
RELEASE_CHANNEL_UNSPECIFIED	未指定发布渠道。默认情况下，系统会选择“常规”渠道。
NONE	无发布渠道。
REGULAR	常规发布渠道。

状态

表示集群的状态。

枚举
STATUS_UNSPECIFIED	状态未知。
PROVISIONING	正在创建集群。
RUNNING	集群已创建并且完全可用。
DELETING	正在删除集群。
ERROR	此状态表示在协调/删除集群时发生了一些错误。
RECONCILING	集群正在进行某些工作，例如版本升级等。

SurvivabilityConfig

集群可维护性的配置，例如在网络连接断开的情况下。

字段
offline_reboot_ttl	Duration 可选。允许集群节点在没有与 Google 建立网络连接的情况下重启并正常运行的时间段。默认值 0 表示不允许。最长为 30 天。

SystemAddonsConfig

客户可以为 GDCE 系统插件定义的配置。

字段
ingress	Ingress 可选。Ingress 的配置。
vm_service_config	VMServiceConfig 可选。虚拟机服务的配置。

入站流量

Ingress 插件的配置，可让客户创建 Ingress 对象来管理对集群中服务器的外部访问。该插件由 istiod 和 istio-ingress 组成。

字段
disabled	bool 可选。Ingress 是否已停用。
ipv4_vip	string 可选。入站流量 VIP。

VMServiceConfig

VMServiceConfig 定义了 GDCE 虚拟机服务的配置。

字段
vmm_enabled	bool 可选。VMM 是否已启用。

ZoneStorageEncryption

区域存储 CMEK 支持的配置

字段
kms_key	string 可选。Cloud KMS 密钥
kms_key_active_version	string 仅限输出。当前用于加密/解密的 Cloud KMS CryptoKeyVersion
resource_state	ResourceState 仅限输出。CMEK 的当前资源状态

ClusterNetworking

集群级网络配置。

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

ClusterUser

RBAC 政策的用户主账号。

字段
username	string 必需。有效的 Google 用户名。

ConfigData

配置数据包含相应区域的所有配置相关数据。

字段
available_external_lb_pools_ipv4[]	string 外部负载平衡器的可用 v4 IP 地址池的列表
available_external_lb_pools_ipv6[]	string 外部负载平衡器的可用 v6 IP 地址池列表

CreateClusterRequest

创建集群。

字段
parent	string 必需。将在其中创建此集群的父级位置。 必须对指定的资源 parent 具有以下 IAM 权限才能进行授权： edgecontainer.clusters.create
cluster_id	string 必需。由客户端指定的集群唯一标识符。
cluster	Cluster 必需。要创建的集群。
request_id	string 相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时，此请求才是幂等的。

CreateIdentityProviderRequest

用于为组织配置身份提供方的请求 proto。

字段
parent	string 必需。要配置的身份提供方的资源名称。例如：organizations/组织/locations/{location}
identity_provider_id	string 必需。身份提供方 ID。
identity_provider	IdentityProvider 必需。要配置的身份提供方。
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 时，此请求才是幂等的。

CreateServiceAccountRequest

用于创建服务账号资源的请求 proto。

字段
parent	string 必需。要配置的身份提供方的资源名称。例如：project/{project}/locations/{location}
service_account_id	string 必需。服务账号 ID。
service_account	ServiceAccount 必需。要配置的服务账号。
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 时，此请求才是幂等的。

DeleteApiKeyRequest

用于删除 API 密钥的请求 proto。

字段
name	string 必需。API 密钥的规范资源名称。例如：projects/{project}/locations/{location}/apiKeys/{api_key}

DeleteClusterRequest

删除集群。

字段
name	string 必需。集群的资源名称。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.clusters.delete
request_id	string 相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时，此请求才是幂等的。

DeleteIdentityProviderRequest

用于删除组织的身份提供方的请求 proto。

字段
name	string 必需。要删除的身份提供方的资源名称。要设置格式的名称，格式为：organizations/组织/locations/{location}/identityProviders/{identity_provider}
request_id	string 可选。相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时，此请求才是幂等的。

DeleteNodePoolRequest

删除节点池。

字段
name	string 必需。节点池的资源名称。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.nodePools.delete
request_id	string 相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时，此请求才是幂等的。

DeleteServiceAccountRequest

用于删除项目服务账号资源的请求 proto。

字段
name	string 必需。项目服务账号的规范资源名称。例如：projects/{project}/locations/{location}/serviceAccounts/{service_account}

DeleteVpnConnectionRequest

删除 VPN 连接。

字段
name	string 必需。VPN 连接的资源名称。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.vpnConnections.delete
request_id	string 相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时，此请求才是幂等的。

EnableZonalProjectRequest

在相应可用区中启用使用方项目（对应于云使用方项目）。

字段
parent	string 必需。将创建项目的父可用区
zonal_project_id	string 必需。要启用的使用方项目的指定 project_id。
zonal_project	ZonalProject 必需。要启用的使用方项目。
request_id	string 可选。相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时，此请求才是幂等的。

EnableZonalProjectResponse

用于启用可用区级项目的响应消息。

字段
zonal_project	ZonalProject 已启用的可用区级项目。

EnableZonalServiceRequest

启用 ZonalService 请求。该 API 将配置集群上服务提供方的访问权限，以创建服务资源。

字段
parent	string 必需。拥有此服务集合的父级位置。
zonal_service_id	string 可选。指定了 zonal_service_id。
zonal_service	ZonalService 必需。要创建的服务。
request_id	string 可选。幂等请求 UUID。

舰队

与舰队相关的配置。

舰队是 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.generateAccessToken

GenerateAccessTokenResponse

集群的访问令牌。

字段
access_token	string 仅限输出。用于向 k8s api-server 进行身份验证的访问令牌。
expire_time	Timestamp 仅限输出。令牌过期时的时间戳。

GenerateOfflineCredentialRequest

为集群生成离线凭据（离线）。

字段
cluster	string 必需。集群的资源名称。 必须对指定的资源 cluster 具有以下 IAM 权限才能进行授权： edgecontainer.clusters.generateOfflineCredential

GenerateOfflineCredentialResponse

集群的离线凭据。

字段
client_certificate	string 仅限输出。用于向 k8s api-server 进行身份验证的客户端证书。
client_key	string 仅限输出。用于向 k8s api-server 进行身份验证的客户端私钥。
user_id	string 仅限输出。客户的身份。
expire_time	Timestamp 仅限输出。相应凭据的过期时间戳。

GenerateServiceAccountKeyRequest

GenerateServiceAccountKey API 的请求 proto。

字段
name	string 必需。项目服务账号的规范资源名称。例如：projects/{project}/locations/{location}/serviceAccounts/{service_account}
validity	Duration 可选。密钥的生命周期。如果未指定，则默认使用期设置为 14 天。
ca_cert_path	string 可选。CA 证书路径。

GenerateServiceAccountKeyResponse

GenerateServiceAccountKey API 的响应 proto。

字段
type	string 凭据类型。
project	string 仅限输出。服务账号所属的项目。
private_key_id	string 仅限输出。私钥 ID。
private_key	string 仅限输出。私钥。
name	string 仅限输出。服务身份的名称。
token_uri	string 仅限输出。令牌 URI。
format_version	string 仅限输出。格式版本。
ca_cert_path	string 仅限输出。CA 证书路径。

GetApiKeyRequest

用于获取 API 密钥的请求 proto。

字段
name	string 必需。要检索的 API 密钥的名称。格式：projects/{project}/locations/{location}/apiKeys/{api_key}

GetClusterRequest

获取集群。

字段
name	string 必需。集群的资源名称。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.clusters.get

GetIamPolicyRequest

用于获取与可用区中的项目关联的 IAM 政策的请求 proto。

字段
name	string 必需。要从中获取 IamPolicy 的区域的规范名称。例如：projects/*/locations/*/zones/*

GetIdentityProviderRequest

用于获取组织的身份提供方的请求 proto。

字段
name	string 必需。身份提供方的规范资源名称。例如：organizations/*/locations/*/identityProviders/*

GetMachineRequest

获取机器。

字段
name	string 必需。虚拟机的资源名称。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.machines.get

GetNodePoolRequest

获取节点池。

字段
name	string 必需。节点池的资源名称。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.nodePools.get

GetServerConfigRequest

获取服务器配置。

字段
name	string 必需。要获取的服务器配置的名称（项目和位置），按 projects/*/locations/* 格式指定。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.serverConfig.get

GetServiceAccountRequest

用于获取服务账号资源的请求 proto。

字段
name	string 必需。项目服务账号的规范资源名称。例如：projects/{project}/locations/{location}/serviceAccounts/{service_account}

GetVpnConnectionRequest

获取 VPN 连接。

字段
name	string 必需。VPN 连接的资源名称。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.vpnConnections.get

GetZonalProjectRequest

获取可用区级项目资源。

字段
name	string 必需。区域项目的规范资源名称。例如：organizations/*/locations/*/zonalProjects/*

GetZonalServiceRequest

获取 ZonalService 请求。

字段
name	string 必需。服务的资源名称。

GetZoneRequest

获取可用区。

字段
name	string 必需。相应地区的规范资源名称。例如：organizations/*/locations/*/zone/*

IamPolicy

IamPolicy 表示 IAM 政策。

字段
bindings[]	Binding 可选。政策是一系列绑定。
etag	string 可选。IAM 政策的 etag。

绑定

Binding 表示 IAM 政策中的角色绑定。

字段
role	string 必需。IAM 政策中要将成员绑定到的角色。
members[]	Principal 可选。要将角色绑定到的成员。

主账号

Principal 表示 IAM 政策中的主账号。

字段
联合字段 identity。要将角色绑定到的主账号。identity 只能是下列其中一项：
user	string 可选。表示 IAM 政策中的用户。
service_account	string 可选。表示 IAM 政策中的服务账号。
group	string 可选。表示 IAM 政策中的群组。

IdentityProvider

表示身份提供方资源，该资源表示组织的身份提供方配置。

字段
name	string 标识符。身份提供方的规范资源名称。例如：organizations/组织/locations/{location}/identityProviders/{identity_provider}
create_time	Timestamp 仅限输出。身份提供方的创建时间。
update_time	Timestamp 仅限输出。身份提供方上次更新的时间。
delete_time	Timestamp 仅限输出。身份提供方被删除的时间。
labels	map<string, string> 可选。与此资源关联的标签。
联合字段 config。身份提供方的配置。config 只能是下列其中一项：
oidc_config	OIDCProviderConfig OIDC 提供商配置。
saml_config	SAMLProviderConfig SAML 提供商配置。
联合字段 target。身份提供方的目标。target 只能是下列其中一项：
zone_id	string 要为其配置身份提供商的基础设施集群的目标可用区 ID。
cluster	string 要为其配置身份提供方的目标 BMUC 的完全限定名称。

KmsKeyState

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

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

ListApiKeysRequest

用于列出 API 密钥的请求 proto。

字段
parent	string 必需。将创建相应密钥的父级资源。格式：projects/{project}/locations/{location}
page_size	int32 可选。要列出的资源数量上限。
page_token	string 可选。从上一个列表请求收到的页面令牌。

ListApiKeysResponse

用于列出 API 密钥的响应 proto。

字段
api_keys[]	ApiKey API 密钥列表。
next_page_token	string 用于检索下一页结果的令牌。
unreachable[]	string 无法到达的位置。

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 无法到达的位置。

ListIdentityProvidersRequest

用于列出组织的身份提供方的请求 proto。

字段
parent	string 必需。身份提供方的父组织和区域。
page_size	int32 可选。要列出的资源数量上限。
page_token	string 可选。从上一个列表请求收到的页面令牌。
filter	string 可选。系统只会列出与此过滤条件匹配的资源。
order_by	string 可选。指定资源的列出顺序。结果的排序依据字段。

ListIdentityProvidersResponse

用于列出组织的身份提供方的响应 proto。

字段
identity_providers[]	IdentityProvider 与请求匹配的身份提供方列表。
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 无法到达的位置。

ListServiceAccountsRequest

列出服务账号的请求。

字段
parent	string 必需。拥有此项目服务账号集合的父级位置。
page_size	int32 可选。要列出的资源数量上限。
page_token	string 可选。从上一个列表请求收到的页面令牌。
filter	string 可选。系统只会列出与此过滤条件匹配的资源。
order_by	string 可选。指定资源的列出顺序。结果的排序依据字段。

ListServiceAccountsResponse

列出 ServiceAccount 的响应。

字段
service_accounts[]	ServiceAccount 与请求匹配的服务账号列表。
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 无法到达的位置。

ListZonalProjectsRequest

列出组织中的使用方项目。

字段
parent	string 必需。将创建项目的父级可用区。
page_size	int32 可选。要列出的资源数量上限。
page_token	string 可选。从上一个列表请求收到的页面令牌。
filter	string 可选。系统只会列出与此过滤条件匹配的资源。
order_by	string 可选。指定资源的列出顺序。结果的排序依据字段。

ListZonalProjectsResponse

组织中的使用方项目列表响应。

字段
zonal_projects[]	ZonalProject 相应位置的集群。
next_page_token	string 用于检索下一页结果的令牌。
unreachable[]	string 无法到达的可用区。

ListZonalServicesRequest

列出 ZonalServices 的请求。

字段
parent	string 必需。拥有此服务集合的父级位置。
page_size	int32 可选。要列出的资源数量上限。
page_token	string 可选。从上一个列表请求收到的页面令牌。
filter	string 可选。系统只会列出与此过滤条件匹配的资源。
order_by	string 可选。指定资源的列出顺序。结果的排序依据字段。

ListZonalServicesResponse

List ZonalServices 响应。

字段
zonal_services[]	ZonalService 位置信息中的 ZonalServices。
next_page_token	string 用于检索下一页结果的令牌。
unreachable[]	string 无法到达的位置。

ListZonesRequest

列出已启用父组织的可用区。

字段
parent	string 必需。父级组织和位置。
page_size	int32 可选。需要返回的最大项数。
page_token	string 可选。从上一个 List 请求返回的 next_page_token 值（如果有）。
filter	string 可选。系统只会列出与此过滤条件匹配的资源。
order_by	string 可选。指定资源的列出顺序。

ListZonesResponse

用于列出可用区的响应消息。

字段
zones[]	Zone 与请求匹配的可用区列表。
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 仅限输出。相应机器是否已停用。如果停用，机器将无法进入服务模式。
status	Status 仅限输出。机器的当前状态。
purpose	Purpose 相应机器所用于的集群类型。

用途

机器用途可以是 VIRTUALIZED_WORKLOAD 或 BAREMETAL_CLUSTER。

枚举
PURPOSE_UNSPECIFIED	未指定用途。
VIRTUALIZED_WORKLOAD	机器用于虚拟工作负载。
BAREMETAL_CLUSTER	机器用于裸金属用户集群。

状态

表示机器的状态。

枚举
STATUS_UNSPECIFIED	状态未知。
READY	机器已准备好托管节点。这是默认设置。
DISABLED_FOR_REPAIR	通过添加 1 项或多项停用声明，已停用相应机器以进行维修。

MaintenanceExclusionWindow

表示维护排除窗口。

字段
window	TimeWindow 可选。时间窗口。
id	string 可选。窗口的唯一（每个集群）ID。

MaintenancePolicy

维护政策配置。

字段
window	MaintenanceWindow 指定可执行维护的维护窗口。
maintenance_exclusions[]	MaintenanceExclusionWindow 可选。自动维护的排除项。在这些时段内不应进行非紧急维护。每项排除对象都有一个唯一的名称，并且可能处于有效状态或已过期。在给定时间允许的维护排除项数量上限为 3。

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 仅限输出。所有工作器节点中的最低发布版本。
node_config	NodeConfig 可选。NodePool 中每个节点的配置

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 报告的错误状态。
resource_state	ResourceState 仅限输出。与 CMEK 关联的当前资源状态。

NodeConfig

NodePool 中每个节点的配置

字段
labels	map<string, string> 可选。Kubernetes 节点标签
node_storage_schema	string 可选。工作器节点的存储架构的名称。
node_system_partition_size	SystemPartitionGiBSize 可选。工作器节点的系统分区大小（以 GiB 为单位）。

OIDCProviderConfig

表示 OIDC 提供商配置。

字段
client_id	string 必需。身份提供方的客户端 ID。
client_secret	string 可选。身份提供方的客户端密钥。
issuer_uri	string 必需。身份提供方的颁发者 URI。
scopes	string 必需。身份提供商的范围。
user_claim	string 可选。身份提供方的用户声明。
extra_params	string 可选。以英文逗号分隔的键值对列表，将采用查询编码并随身份验证端点请求发送。
certificate_authority_data	string 可选。身份提供方的证书授权机构数据。
group_claim	string 可选。身份提供商的群组声明。
attribute_mapping	map<string, string> 可选。身份提供方的属性映射。

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 不会阻止操作，但仍包含相关信息供最终用户接收的警告。
status_reason	StatusReason 机器可读的操作状态（如果有）。

StatusReason

指明操作状态的原因。

枚举
STATUS_REASON_UNSPECIFIED	原因未知。
UPGRADE_PAUSED	集群升级目前已暂停。
RETRYABLE_ERROR	请求出错，但可以重试。

配额

表示 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)。它们会在开始时间和结束时间之间持续显示。

ResourceState

表示资源是否处于锁定状态或待处理状态。

枚举
RESOURCE_STATE_UNSPECIFIED	默认值。
RESOURCE_STATE_LOCK_DOWN	资源处于锁定状态。
RESOURCE_STATE_LOCK_DOWN_PENDING	资源待锁定。

SAMLProviderConfig

表示 SAML 提供商配置。

字段
entity_id	string 必需。身份提供方的实体 ID。
single_sign_on_uri	string 必需。身份提供方的单点登录 URI。
certificate_data[]	string 可选。身份提供方的证书数据。
user_attribute	string 可选。身份提供方的用户属性。
group_attribute	string 可选。身份提供方的群组属性。
attribute_mapping	map<string, string> 可选。身份提供方的属性映射。

ServerConfig

支持的版本和发布渠道的服务器配置。

字段
channels	map<string, ChannelConfig> 仅限输出。从发布渠道到渠道配置的映射。
versions[]	Version 仅限输出。支持的版本，例如：["1.4.0", "1.5.0"]。
default_version	string 仅限输出。默认版本，例如：“1.4.0”。
version_rollouts[]	VersionRollout 仅限输出。服务器配置的发布信息。

ServiceAccount

表示服务账号资源。

字段
name	string 标识符。项目服务账号的规范资源名称。例如：projects/{project}/locations/{location}/serviceAccounts/{service_account}
zone	string 必需。项目服务账号必须创建到的可用区的可用区 ID。
create_time	Timestamp 仅限输出。项目服务账号的创建时间。
update_time	Timestamp 仅限输出。项目服务账号上次更新的时间。
labels	map<string, string> 可选。与此资源关联的标签。
state	State 仅限输出。服务账号的状态。

州

服务账号的状态。

枚举
STATE_UNSPECIFIED	未指定。
CREATING	服务账号处于“正在创建”状态。
RUNNING	服务账号处于 RUNNING 状态。
DELETING	服务账号处于 DELETING 状态。
ERROR	服务账号处于错误状态。
REPAIRING	服务账号处于 REPAIRING 状态。

SetIamPolicyRequest

用于在可用区中为项目设置 IAM 政策的请求 proto。

字段
name	string 必需。可用区的规范资源名称。projects/{project}/locations/{location}/zones/{zone}
policy	IamPolicy 必需。要设置的 IAM 政策。
request_id	string 可选。相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时，此请求才是幂等的。

SystemPartitionGiBSize

SystemPartitionGiBSize 表示允许的系统分区大小（以 GiB 为单位）。

枚举
SYSTEM_PARTITION_GIB_SIZE_UNSPECIFIED	用户未指定系统分区大小。这会导致系统分区大小设置为适用于相应节点的系统存储空间架构中指定的大小，即 100GiB。
SYSTEM_PARTITION_GIB_SIZE100	100GiB 系统分区大小，也是默认大小。
SYSTEM_PARTITION_GIB_SIZE300	300GiB 系统分区大小。可用于替换 100 GiB 的默认值。

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 时，此请求才是幂等的。

UpgradeClusterRequest

升级集群。

字段
name	string 必需。集群的资源名称。 必须对指定的资源 name 具有以下 IAM 权限才能进行授权： edgecontainer.clusters.upgrade
target_version	string 必需。集群将升级到的版本。
schedule	Schedule 升级时间表。
request_id	string 相应请求的唯一标识符。仅限 36 个 ASCII 字符。建议使用随机 UUID。仅当提供 request_id 时，此请求才是幂等的。

时间表

表示集群将要升级的时间安排。

枚举
SCHEDULE_UNSPECIFIED	未指定。默认设置为立即升级集群，这也是目前唯一的选项。
IMMEDIATELY	集群将在收到请求后立即升级。

版本

集群的版本。

字段
name	string 仅限输出。版本的名称，例如：“1.4.0”。

VersionRollout

VersionRollout 包含版本发布信息。

字段
version	string 仅限输出。语义版本，例如：“1.4.0”。
available_zones[]	string 仅限输出。已推出相应版本的可用区列表，例如：["us-central1", "us-west1"]。

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 网络的动态路由模式，regional 或 global。
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。
router	string 可选。VPN 连接 Cloud Router 名称。
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 此项已弃用！ 可选。已弃用：请勿使用。

ZonalProject

在可用区中启用的可用区级项目（对应于云使用方项目）。

字段
name	string 标识符。项目的资源名称。
create_time	Timestamp 仅限输出。项目创建的时间。
update_time	Timestamp 仅限输出。项目上次更新的时间。
labels	map<string, string> 可选。与此资源关联的标签。
state	State 仅限输出。项目在可用区中的状态。

州

项目在可用区中的状态。

枚举
STATE_UNSPECIFIED	未指定。
STATE_ON	项目已在可用区中启用。
STATE_OFF	项目在可用区中处于停用状态。

ZonalService

已在项目上启用服务。

字段
name	string 标识符。服务的资源名称。
service_selector	ServiceSelector 可选。要启用/停用的服务。只能指定 service_selector 或 service_name 中的一个。
state	State 仅限输出。服务的状态。
create_time	Timestamp 仅限输出。启用服务的时间。
update_time	Timestamp 仅限输出。服务上次更新的时间。
labels	map<string, string> 可选。与此资源关联的标签。
联合字段 zone_or_cluster。必须启用/停用服务的地区或集群。zone_or_cluster 只能是下列其中一项：
zone	string 必须启用/停用服务的地区的地区 ID。
cluster	string 必须启用/停用服务的集群的完全限定名称。
service_name	string 可选。完整服务名称，例如：alloydb.googleapis.com。只能指定 service_selector 或 service_name 中的一个。它将用于启用/停用项目中的服务。

ServiceSelector

可启用/停用的服务。

枚举
SERVICE_SELECTOR_UNSPECIFIED	未指定。
ALLOYDB	AlloyDB 服务 (alloydb.googleapis.com)。
VMM	VMM 服务，gdcvmmanager.googleapis.com。
BOOKSTORE	书店服务，bookstore.googleapis.com。
VERTEX	Vertex 服务，aiplatform.googleapis.com。
BOOKSTORE_AI	Bookstore.AI 服务，bookstore-ai.googleapis.com。

州

服务的状态。

枚举
STATE_UNSPECIFIED	未指定。
STATE_ENABLED	已在项目上启用服务。
STATE_DISABLED	服务已在项目上停用。
STATE_ENABLING	正在为项目启用服务。
STATE_DISABLING	正在项目中停用服务。
STATE_REPAIRING	正在维修服务。

可用区

表示可用区。

字段
name	string 标识符。相应地区的规范资源名称。例如：organizations/组织/locations/{location}/zones/{zone}
create_time	Timestamp 仅限输出。相应时区的创建时间。
labels	map<string, string> 可选。与此资源关联的标签。
certificate_authorities[]	string 仅限输出。相应地区的 Web CA 证书。
dns_servers[]	DNSServer 仅限输出。相应可用区的 DNS 服务器。
state	State 仅限输出。可用区的状态。

DNSServer

表示相应地区的 DNS 服务器。

字段
ip_address	string 仅限输出。DNS 服务器的 IP 地址。
tld	string 仅限输出。DNS 服务器的顶级域名。

州

可用区的状态。

枚举
STATE_UNSPECIFIED	未指定。
STATE_RUNNING	相应可用区处于“运行中”状态。
STATE_ERROR	相应可用区处于错误状态。
STATE_CREATING	相应可用区处于“正在创建”状态。
STATE_REPAIRING	相应可用区处于修复状态。

ZoneMetadata

Google Distributed Cloud Edge 可用区，边缘机器位于其中。

字段
quota[]	Quota 相应可用区中资源的配额。
rack_types	map<string, RackType> 以机架名称为键，以 RackType 为值的映射。
config_data	ConfigData 相应时区的配置数据。

RackType

机架类型。

枚举
RACK_TYPE_UNSPECIFIED	未指定的机架类型，单个机架也属于此类型。
BASE	基本机架类型，一对包含聚合交换机的修改后的 Config-1 机架。
EXPANSION	扩展机架类型，也称为独立机架，由客户根据需求添加。