索引
EdgeContainer(介面)Authorization(訊息)Cluster(訊息)ClusterNetworking(訊息)ClusterUser(訊息)CreateClusterRequest(訊息)CreateNodePoolRequest(訊息)CreateVpnConnectionRequest(訊息)DeleteClusterRequest(訊息)DeleteNodePoolRequest(訊息)DeleteVpnConnectionRequest(訊息)Fleet(訊息)GenerateAccessTokenRequest(訊息)GenerateAccessTokenResponse(訊息)GetClusterRequest(訊息)GetMachineRequest(訊息)GetNodePoolRequest(訊息)GetVpnConnectionRequest(訊息)KmsKeyState(enum)ListClustersRequest(訊息)ListClustersResponse(訊息)ListMachinesRequest(訊息)ListMachinesResponse(訊息)ListNodePoolsRequest(訊息)ListNodePoolsResponse(訊息)ListVpnConnectionsRequest(訊息)ListVpnConnectionsResponse(訊息)LocationMetadata(訊息)Machine(訊息)MaintenancePolicy(訊息)MaintenanceWindow(訊息)NodePool(訊息)NodePool.LocalDiskEncryption(訊息)OperationMetadata(訊息)Quota(訊息)RecurringTimeWindow(訊息)TimeWindow(訊息)UpdateClusterRequest(訊息)UpdateNodePoolRequest(訊息)VpnConnection(訊息)VpnConnection.BgpRoutingMode(enum)VpnConnection.Details(訊息)VpnConnection.Details.CloudRouter(訊息)VpnConnection.Details.CloudVpn(訊息)VpnConnection.Details.State(enum)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 |
這是必要旗標,會在叢集中獲得叢集管理員角色的使用者,具備叢集的完整存取權。目前只能填寫一個欄位,但日後會擴充,允許填寫多位管理員。 |
叢集
Google Distributed Cloud Edge Kubernetes 叢集。
| 欄位 | |
|---|---|
name |
這是必要旗標,叢集的資源名稱。 |
create_time |
僅供輸出。叢集的建立時間。 |
update_time |
僅供輸出。叢集上次更新的時間。 |
labels |
與這個資源相關聯的標籤。 |
fleet |
選用。機群設定。 |
networking |
這是必要旗標,全叢集網路設定。 |
authorization |
這是必要旗標,不可變動。由 GEC 套用及管理的 RBAC 政策。 |
default_max_pods_per_node |
選用。當這個叢集中未明確指定節點集區的最大值時,每個節點的預設 pod 數量上限。如未指定,系統會使用 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 使用者名稱。 |
建立叢集要求
建立叢集。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立這個叢集的父項位置。 授權需要指定資源
|
cluster_id |
這是必要旗標,叢集的專屬 ID,由用戶端指定。 |
cluster |
這是必要旗標,要建立的叢集。 |
request_id |
這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 |
CreateNodePoolRequest
建立節點集區。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立這個節點集區的父項叢集。 授權需要指定資源
|
node_pool_id |
這是必要旗標,節點集區的用戶端指定專屬 ID。 |
node_pool |
這是必要旗標,要建立的節點集區。 |
request_id |
這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 |
CreateVpnConnectionRequest
建立 VPN 連線。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立這個 VPN 連線的父項位置。 授權需要指定資源
|
vpn_connection_id |
這是必要旗標,VPN 連線 ID。 |
vpn_connection |
這是必要旗標,要建立的 VPN 連線。 |
request_id |
這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 |
刪除叢集要求
刪除叢集。
| 欄位 | |
|---|---|
name |
這是必要旗標,叢集的資源名稱。 授權需要指定資源
|
request_id |
這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 |
DeleteNodePoolRequest
刪除節點集區。
| 欄位 | |
|---|---|
name |
這是必要旗標,節點集區的資源名稱。 授權需要指定資源
|
request_id |
這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 |
DeleteVpnConnectionRequest
刪除 VPN 連線。
| 欄位 | |
|---|---|
name |
這是必要旗標,VPN 連線的資源名稱。 授權需要指定資源
|
request_id |
這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 |
機群
機群相關設定。
「機群」是按照邏輯整理叢集的 Google Cloud 概念,可讓您使用及管理多叢集功能,並在不同系統中套用一致的政策。
| 欄位 | |
|---|---|
project |
這是必要旗標,這個叢集註冊的機群主專案名稱。 專案名稱的格式為 |
membership |
僅供輸出。與這個叢集相關聯的代管 Hub Membership 資源名稱。 會員名稱的格式為 |
GenerateAccessTokenRequest
為叢集產生存取權杖。
| 欄位 | |
|---|---|
cluster |
這是必要旗標,叢集的資源名稱。 授權需要指定資源
|
GenerateAccessTokenResponse
叢集的存取權杖。
| 欄位 | |
|---|---|
access_token |
僅供輸出。用於向 k8s api-server 驗證的存取權杖。 |
expire_time |
僅供輸出。權杖到期時間的時間戳記。 |
取得叢集要求
取得叢集。
| 欄位 | |
|---|---|
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 |
金鑰因不明原因而無法使用。可能無法存取依附資源。 |
列出叢集要求
列出某個位置的叢集。
| 欄位 | |
|---|---|
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[] |
該位置的 VpnConnections。 |
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 |
設定週期性維護期間。 |
NodePool
叢集中的一組 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 CryptoKey (例如: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 |
欄位遮罩用於指定更新作業要覆寫叢集資源中的哪些欄位。update_mask 中指定的欄位與資源相關,而非完整要求。如果欄位位於遮罩中,系統會覆寫該欄位。如果使用者未提供遮罩,系統會覆寫所有欄位。 |
cluster |
更新後的叢集。 授權需要指定資源
|
request_id |
這項要求的專屬 ID。最多只能包含 36 個 ASCII 字元。建議使用隨機 UUID。只有在提供 |
UpdateNodePoolRequest
更新節點集區。
| 欄位 | |
|---|---|
update_mask |
欄位遮罩用於指定更新作業要覆寫 NodePool 資源中的哪些欄位。update_mask 中指定的欄位與資源相關,而非完整要求。如果欄位位於遮罩中,系統會覆寫該欄位。如果使用者未提供遮罩,系統會覆寫所有欄位。 |
node_pool |
更新後的節點集區。 授權需要指定資源
|
request_id |
這項要求的專屬 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 |
要連線的虛擬私有雲網路 ID。 |
vpc_project |
選用。虛擬私有雲網路的專案詳細資料。如果虛擬私有雲與叢集專案位於不同專案,則為必填。 |
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
虛擬私有雲網路的專案詳細資料。
| 欄位 | |
|---|---|
project_id |
要連線的虛擬私有雲專案。如未指定,則與叢集專案相同。 |
service_account |
選用。使用者在 VPC 專案中設定的服務帳戶。用於建立/刪除 Cloud Router 和 Cloud 高可用性 VPN,以建立 VPN 連線。如果在建立 VPN 連線期間/之後變更這個服務帳戶,您必須移除 |project_id| 中的 Cloud Router 和 Cloud VPN 資源。服務帳戶的格式為 service-{project_number}@gcp-sa-edgecontainer.iam.gserviceaccount.com。 |
ZoneMetadata
邊緣機器所在的 Google Distributed Cloud Edge 可用區。
| 欄位 | |
|---|---|
quota[] |
這個可用區的資源配額。 |