Method: projects.locations.vmwareClusters.enroll

將現有的 VMware 使用者叢集及其節點集區，註冊至指定專案和位置的 Anthos On-Prem API。註冊後，現有叢集就會由 Anthos On-Prem API 管理。系統會建立對應的 GCP 資源，日後對叢集和/或節點集區的所有修改，都必須透過 API 進行。

HTTP 要求

POST https://gkeonprem.googleapis.com/v1/{parent=projects/*/locations/*}/vmwareClusters:enroll

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標，叢集註冊的專案和位置的父項。格式：「projects/{project}/locations/{location}」

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "vmwareClusterId": string,
  "localName": string,
  "adminClusterMembership": string,
  "validateOnly": boolean
}
欄位
vmwareClusterId

string

使用者提供的 OnePlatform ID，會做為資源名稱的一部分。在專案和位置內的所有 GKE On-prem 叢集中，這個名稱不得重複。如果叢集已存在，系統會傳回 409 錯誤。

(https://tools.ietf.org/html/rfc1123) 格式。
localName

string

(選用步驟) 相關聯管理員叢集上 VMware OnPremUserCluster 自訂資源的物件名稱。將現有叢集註冊至 API 時，這個欄位可用於支援資源名稱衝突。如未提供，這個欄位會解析為 vmwareClusterId。否則必須與 VMware OnPremUserCluster 自訂資源的物件名稱相符。註冊作業以外的時間 / 情況無法修改。
adminClusterMembership

string

這是必要旗標，這個 VMware 使用者叢集所屬的管理員叢集。這是管理員叢集機群成員的完整資源名稱。如果管理員叢集是做為自己的資源建模，未來或許可以參照其他資源類型。
validateOnly

boolean

驗證要求，但不實際進行任何更新。

回應主體

如果成功，回應主體會包含 Operation 的執行個體。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。