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

詳情請參閱Authentication Overview。
CreateNodePool

rpc CreateNodePool(CreateNodePoolRequest) returns (Operation)

在指定專案和位置中建立新的 NodePool。

授權範圍

需要下列 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。
DeleteCluster

rpc DeleteCluster(DeleteClusterRequest) returns (Operation)

刪除單一叢集。

授權範圍

需要下列 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。
DeleteVpnConnection

rpc DeleteVpnConnection(DeleteVpnConnectionRequest) returns (Operation)

刪除單一 VPN 連線。

授權範圍

需要下列 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。
GetCluster

rpc GetCluster(GetClusterRequest) returns (Cluster)

取得單一叢集的詳細資料。

授權範圍

需要下列 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。
GetVpnConnection

rpc GetVpnConnection(GetVpnConnectionRequest) returns (VpnConnection)

取得單一 VPN 連線的詳細資料。

授權範圍

需要下列 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。
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。
ListVpnConnections

rpc ListVpnConnections(ListVpnConnectionsRequest) returns (ListVpnConnectionsResponse)

列出指定專案和位置中的 VPN 連線。

授權範圍

需要下列 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。

授權

由 GEC 套用及管理的 RBAC 政策。

欄位
admin_users

ClusterUser

這是必要旗標，會在叢集中獲得叢集管理員角色的使用者，具備叢集的完整存取權。目前只能填寫一個欄位，但日後會擴充，允許填寫多位管理員。

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

選用。當這個叢集中未明確指定節點集區的最大值時，每個節點的預設 pod 數量上限。如未指定，系統會使用 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_cluster_isolation

bool

選用。這表示叢集是否需要隔離。go/cluster-isolation-in-gdcc-cluster

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

選用。控制層節點的儲存空間結構定義名稱。

遠端

這個類型沒有任何欄位。

適用於控制層遠端代管的叢集。

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。

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 未指定發布版本。系統會預設為 REGULAR 頻道。
NONE 未指定發布版本。
REGULAR 一般發布版本。

狀態

顯示叢集狀態。

列舉
STATUS_UNSPECIFIED 狀態不明。
PROVISIONING 正在建立叢集。
RUNNING 叢集已建立完成，可供使用。
DELETING 正在刪除叢集。
ERROR 狀態顯示在調解/刪除叢集時發生一些錯誤。
RECONCILING 叢集正在進行某些作業，例如版本升級等。

SurvivabilityConfig

叢集存續性設定，例如網路連線中斷時的設定。

欄位
offline_reboot_ttl

Duration

選用。這段時間內，叢集節點可重新啟動並恢復運作，無須連上 Google 網路。預設值為 0，表示不允許。最長不得超過 7 天。

SystemAddonsConfig

客戶可為 GDCE 系統外掛程式定義的設定。

欄位
ingress

Ingress

選用。輸入設定的設定。
vm_service_config

VMServiceConfig

選用。VM 服務的設定。

輸入

Ingress 外掛程式的設定，可讓客戶建立 Ingress 物件，管理叢集中伺服器的外部存取權。外掛程式包含 istiod 和 istio-ingress。

欄位
disabled

bool

選用。Ingress 是否已停用。
ipv4_vip

string

選用。Ingress VIP。

VMServiceConfig

VMServiceConfig 定義 GDCE VM 服務的設定。

欄位
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 集區清單

建立叢集要求

建立叢集。

欄位
parent

string

這是必要旗標，要建立這個叢集的父項位置。

授權需要指定資源 parent 的下列 IAM 權限：

  • edgecontainer.clusters.create
cluster_id

string

這是必要旗標，叢集的專屬 ID，由用戶端指定。
cluster

Cluster

這是必要旗標，要建立的叢集。
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

CreateNodePoolRequest

建立節點集區。

欄位
parent

string

這是必要旗標，要建立這個節點集區的父項叢集。

授權需要指定資源 parent 的下列 IAM 權限：

  • edgecontainer.nodePools.create
node_pool_id

string

這是必要旗標，節點集區的用戶端指定專屬 ID。
node_pool

NodePool

這是必要旗標，要建立的節點集區。
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

CreateVpnConnectionRequest

建立 VPN 連線。

欄位
parent

string

這是必要旗標，要建立這個 VPN 連線的父項位置。

授權需要指定資源 parent 的下列 IAM 權限：

  • edgecontainer.vpnConnections.create
vpn_connection_id

string

這是必要旗標，VPN 連線 ID。
vpn_connection

VpnConnection

這是必要旗標，要建立的 VPN 連線。
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

刪除叢集要求

刪除叢集。

欄位
name

string

這是必要旗標，叢集的資源名稱。

授權需要指定資源 name 的下列 IAM 權限：

  • edgecontainer.clusters.delete
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

DeleteNodePoolRequest

刪除節點集區。

欄位
name

string

這是必要旗標，節點集區的資源名稱。

授權需要指定資源 name 的下列 IAM 權限：

  • edgecontainer.nodePools.delete
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

DeleteVpnConnectionRequest

刪除 VPN 連線。

欄位
name

string

這是必要旗標，VPN 連線的資源名稱。

授權需要指定資源 name 的下列 IAM 權限：

  • edgecontainer.vpnConnections.delete
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

機群

機群相關設定。

「機群」是按照邏輯整理叢集的 Google Cloud 概念，可讓您使用及管理多叢集功能，並在不同系統中套用一致的政策。

欄位
project

string

這是必要旗標，這個叢集註冊的機群主專案名稱。

專案名稱的格式為 projects/<project-number>。
membership

string

僅供輸出。與這個叢集相關聯的代管 Hub Membership 資源名稱。

會員名稱的格式為 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 伺服器驗證身分的用戶端憑證。
client_key

string

僅供輸出。用於向 k8s API 伺服器驗證的用戶端私密金鑰。
user_id

string

僅供輸出。用戶端的身分。
expire_time

Timestamp

僅供輸出。這項憑證的到期時間戳記。

取得叢集要求

取得叢集。

欄位
name

string

這是必要旗標，叢集的資源名稱。

授權需要指定資源 name 的下列 IAM 權限：

  • edgecontainer.clusters.get

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

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 金鑰因不明原因而無法使用。可能無法存取依附資源。

列出叢集要求

列出某個位置的叢集。

欄位
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

該位置的 VpnConnections。
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 機器用於 bare metal 使用者叢集。

狀態

顯示機器的狀態。

列舉
STATUS_UNSPECIFIED 狀態不明。
READY 機器已準備好代管節點。這是目前的預設做法。
DISABLED_FOR_REPAIR 新增一或多項停用聲明後，機器已停用維修。

MaintenanceExclusionWindow

代表維護排除時段。

欄位
window

TimeWindow

選用。時間範圍。
id

string

選用。視窗的專屬 (每個叢集) ID。

MaintenancePolicy

維護政策設定。

欄位
window

MaintenanceWindow

指定可執行維護作業的維護期間。
maintenance_exclusions[]

MaintenanceExclusionWindow

選用。自動維護作業的排除時段。非緊急維護作業不應在這些時段進行。每個排除條件都有專屬名稱，且可能有效或已過期。一次最多可排除 3 個維護項目。

MaintenanceWindow

維護期間設定

欄位
recurring_window

RecurringTimeWindow

設定週期性維護期間。

NodePool

叢集中的一組 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 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 相關聯的目前資源狀態。

NodeConfig

NodePool 中每個節點的設定

欄位
labels

map<string, string>

選用。Kubernetes 節點標籤
node_storage_schema

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 叢集升級作業目前已暫停。

配額

代表 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 資源處於 LOCK DOWN 狀態。
RESOURCE_STATE_LOCK_DOWN_PENDING 資源即將鎖定。

ServerConfig

支援版本和發布通路的伺服器設定。

欄位
channels

map<string, ChannelConfig>

僅供輸出。從發布版本對應至管道設定。
versions[]

Version

僅供輸出。支援的版本，例如：["1.4.0", "1.5.0"]。
default_version

string

僅供輸出。預設版本，例如：「1.4.0」。

TimeWindow

代表任意時間範圍。

欄位
start_time

Timestamp

視窗首次啟動的時間。
end_time

Timestamp

時間範圍的結束時間。結束時間必須晚於開始時間。

UpdateClusterRequest

更新叢集。

欄位
update_mask

FieldMask

欄位遮罩用於指定更新作業要覆寫叢集資源中的哪些欄位。update_mask 中指定的欄位與資源相關，而非完整要求。如果欄位位於遮罩中，系統會覆寫該欄位。如果使用者未提供遮罩，系統會覆寫所有欄位。
cluster

Cluster

更新後的叢集。

授權需要指定資源 cluster 的下列 IAM 權限：

  • edgecontainer.clusters.update
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

UpdateNodePoolRequest

更新節點集區。

欄位
update_mask

FieldMask

欄位遮罩用於指定更新作業要覆寫 NodePool 資源中的哪些欄位。update_mask 中指定的欄位與資源相關，而非完整要求。如果欄位位於遮罩中，系統會覆寫該欄位。如果使用者未提供遮罩，系統會覆寫所有欄位。
node_pool

NodePool

更新後的節點集區。

授權需要指定資源 nodePool 的下列 IAM 權限：

  • edgecontainer.nodePools.update
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

UpgradeClusterRequest

升級叢集。

欄位
name

string

這是必要旗標，叢集的資源名稱。

授權需要指定資源 name 的下列 IAM 權限：

  • edgecontainer.clusters.upgrade
target_version

string

這是必要旗標，叢集要升級的版本。
schedule

Schedule

升級時間表。
request_id

string

這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 request_id 時，這項要求才會是等冪。

排程

代表叢集升級時間表。

列舉
SCHEDULE_UNSPECIFIED 不明。系統預設會立即升級叢集，目前只有這個選項。
IMMEDIATELY 收到要求後，叢集會立即升級。

版本

叢集版本。

欄位
name

string

僅供輸出。版本名稱，例如：「1.4.0」。

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

要連線的虛擬私有雲網路 ID。
vpc_project

VpcProject

選用。虛擬私有雲網路的專案詳細資料。如果虛擬私有雲與叢集專案位於不同專案，則為必填。
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

虛擬私有雲網路的專案詳細資料。

欄位
project_id

string

要連線的虛擬私有雲專案。如未指定，則與叢集專案相同。
service_account
(deprecated)

string

選用。已淘汰，請勿使用。

ZoneMetadata

邊緣機器所在的 Google Distributed Cloud Edge 可用區。

欄位
quota[]

Quota

這個可用區的資源配額。
rack_types

map<string, RackType>

以機架名稱做為索引鍵的地圖，且值為 RackType。
config_data

ConfigData

區域的設定資料。

RackType

機架類型。

列舉
RACK_TYPE_UNSPECIFIED 未指定機架類型，單一機架也屬於這種類型。
BASE 基本機架類型，一對包含聚合交換器的修改版 Config-1 機架。
EXPANSION 擴充架類型 (又稱獨立式機架)，由顧客視需求新增。