REST Resource: projects.locations.privateClouds.clusters

資源：叢集

私有雲中的叢集。

JSON 表示法 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "management": boolean,
  "autoscalingSettings": {
    object (AutoscalingSettings)
  },
  "uid": string,
  "nodeTypeConfigs": {
    string: {
      object (NodeTypeConfig)
    },
    ...
  },
  "stretchedClusterConfig": {
    object (StretchedClusterConfig)
  },
  "datastoreMountConfig": [
    {
      object (DatastoreMountConfig)
    }
  ]
}
欄位
name

string

僅供輸出。ID。這個叢集的資源名稱。資源名稱是無配置的 URI，遵循 https://cloud.google.com/apis/design/resource_names 中的慣例。例如：projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster
createTime

string (Timestamp format)

僅供輸出。這項資源的建立時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

僅供輸出。這項資源的上次更新時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
state

enum (State)

僅供輸出。資源狀態。
management

boolean

僅供輸出。如果叢集是管理叢集，則為 True；否則為 False。私有雲中只能有一個管理叢集，且必須是第一個叢集。
autoscalingSettings

object (AutoscalingSettings)

選用。套用至這個叢集的自動調度資源設定。
uid

string

僅供輸出。系統為資源產生的專屬 ID。
nodeTypeConfigs

map (key: string, value: object (NodeTypeConfig))

這是必要旗標，這個叢集中的叢集節點類型對應表，其中鍵是節點類型的標準 ID (對應至 NodeType)。

包含 "key": value 組合清單的物件，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
stretchedClusterConfig

object (StretchedClusterConfig)

選用。延展叢集的設定。如果叢集屬於延展的私有雲，則必須使用這個選項。
datastoreMountConfig[]

object (DatastoreMountConfig)

僅供輸出。已掛接資料存放區的設定。

狀態

列舉 State 定義私有雲叢集的可能狀態。

列舉
STATE_UNSPECIFIED 預設值。請一律不要使用這個值。
ACTIVE 叢集運作正常，使用者可以正常使用。
CREATING 正在部署叢集。
UPDATING 在叢集中新增或移除節點，以及任何其他叢集專屬更新。
DELETING 正在刪除叢集。
REPAIRING 叢集正在進行維護作業，例如：更換故障節點。

AutoscalingSettings

自動調度設定會定義 VMware Engine 用來自動擴大及縮減私有雲中叢集的規則。

JSON 表示法 
{
  "autoscalingPolicies": {
    string: {
      object (AutoscalingPolicy)
    },
    ...
  },
  "minClusterNodeCount": integer,
  "maxClusterNodeCount": integer,
  "coolDownPeriod": string
}
欄位
autoscalingPolicies

map (key: string, value: object (AutoscalingPolicy))

這是必要旗標，地圖：自動調度資源政策已套用至叢集。這個鍵是政策的 ID。且必須符合下列規定：

  • 只能包含 1 到 63 個英數字元和連字號
  • 以英文字母開頭
  • 結尾為非連字號字元
  • 格式不是 UUID
  • 符合 RFC 1034 (3.5 節)

目前地圖只能包含一個元素，用於說明運算節點的自動調度資源政策。

包含 "key": value 組合清單的物件，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
minClusterNodeCount

integer

選用。叢集中任何類型的節點數量下限。如未指定，系統會套用預設限制。
maxClusterNodeCount

integer

選用。叢集中任何類型的節點數上限。如未指定，系統會套用預設限制。
coolDownPeriod

string (Duration format)

選用。連續自動調度作業之間的最短時間長度。節點新增或移除作業完成後，系統就會開始執行。如果未指定，預設值為 30 分鐘。等待期必須以整數分鐘為單位 (例如 30、31、50、180 分鐘)。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。

AutoscalingPolicy

自動調度資源政策會說明自動調度資源的行為，以及資源使用率。如果使用率超過任何門檻，系統就會啟動擴充作業。如果使用率低於所有相關門檻，系統就會啟動縮減作業。

JSON 表示法 
{
  "nodeTypeId": string,
  "scaleOutSize": integer,
  "cpuThresholds": {
    object (Thresholds)
  },
  "grantedMemoryThresholds": {
    object (Thresholds)
  },
  "consumedMemoryThresholds": {
    object (Thresholds)
  },
  "storageThresholds": {
    object (Thresholds)
  }
}
欄位
nodeTypeId

string

這是必要旗標，要新增或移除的節點類型標準 ID。對應至 NodeType。
scaleOutSize

integer

這是必要旗標，在向外擴充作業期間，要新增至叢集的節點數量。如果是延展叢集，則必須可除以 2。在縮減作業期間，單一疊代只會移除一個節點 (或延伸叢集的 2 個節點)。
cpuThresholds

object (Thresholds)

選用。CPU 使用率的相關使用率門檻。
grantedMemoryThresholds

object (Thresholds)

選用。獲派記憶體量的使用率門檻。
consumedMemoryThresholds

object (Thresholds)

選用。與消耗記憶體量相關的使用率門檻。
storageThresholds

object (Thresholds)

選用。與儲存空間用量相關的使用率門檻。

門檻

門檻會定義觸發擴充和縮減作業的資源用量。

JSON 表示法 
{
  "scaleOut": integer,
  "scaleIn": integer
}
欄位
scaleOut

integer

這是必要旗標，觸發擴充作業的使用率 (百分比)。
scaleIn

integer

這是必要旗標，觸發縮減作業的使用率 (百分比)。

DatastoreMountConfig

資料儲存庫掛接設定

JSON 表示法 
{
  "fileShare": string,
  "datastore": string,
  "datastoreNetwork": {
    object (DatastoreNetwork)
  },
  "accessMode": enum (AccessMode),
  "nfsVersion": enum (NfsVersion),
  "servers": [
    string
  ]
}
欄位
fileShare

string

僅供輸出。檔案共用區名稱。
datastore

string

這是必要旗標，要掛接的資料儲存庫資源名稱。資源名稱是無配置的 URI，遵循 https://cloud.google.com/apis/design/resource_names 中的慣例。例如：projects/my-project/locations/us-central1/datastores/my-datastore
datastoreNetwork

object (DatastoreNetwork)

這是必要旗標，資料儲存庫的網路設定。
accessMode

enum (AccessMode)

選用。NFS 磁碟區的存取模式。選用。系統會使用 READ_WRITE 預設值
nfsVersion

enum (NfsVersion)

選用。NFS 磁碟區支援的 NFS 通訊協定。系統會使用 NFS_V3 預設值
servers[]

string

僅供輸出。NFS 磁碟區的伺服器 IP 位址。如果是 NFS 3，您只能提供單一伺服器 IP 位址或 DNS 名稱。

DatastoreNetwork

資料儲存庫的網路設定。

JSON 表示法 
{
  "subnet": string,
  "mtu": integer,
  "networkPeering": string,
  "connectionCount": integer
}
欄位
subnet

string

這是必要旗標，子網路的資源名稱。資源名稱是不含結構定義的 URI，遵循 https://cloud.google.com/apis/design/resource_names 中的慣例。例如：projects/my-project/locations/us-central1/subnets/my-subnet
mtu

integer

選用。系統會為 NFS 流量的 VMKernel 配接卡設定 MTU 值。如未提供，則會使用 1500 的 MTU。如要使用巨型封包，請將此值設為 8896。建議您根據 NFS 流量效能調整這個值。您可以使用 fio (彈性 I/O 測試工具) 公用程式等基準化 I/O 工具，判斷效能。
networkPeering

string

僅供輸出。網路對等互連的資源名稱，用於讓私有雲上的用戶端存取檔案共用。資源名稱是不含結構定義的 URI，遵循 https://cloud.google.com/apis/design/resource_names 中的慣例，例如：projects/my-project/locations/us-central1/networkPeerings/my-network-peering
connectionCount

integer

選用。connectionCount 用於在 ESXi 主機上，從 NFS 用戶端設定多個連線至 NFS 伺服器。連線數越多，資料儲存區的效能就越好。根據預設，叢集中的 clusters.mountDatastore API 最多可設定 4 個連線。使用者可將 connectionCount 的值設為 1 到 4。從 vSphere 8.0u1 開始支援 Connection_count，舊版則是在 ESXi 主機上設定 1 個連線計數。

AccessMode

NFS 磁碟區的存取模式。

列舉
ACCESS_MODE_UNSPECIFIED 預設值。請一律不要使用這個值。
READ_ONLY 主機以讀取模式存取 NFS
READ_WRITE 主機以讀寫模式存取 NFS

NfsVersion

NFS 磁碟區支援的 NFS 通訊協定。

列舉
NFS_VERSION_UNSPECIFIED 預設值。請一律不要使用這個值。
NFS_V3 NFS 3

方法

create

 在指定的私有雲中建立新叢集。

delete

 刪除 Cluster 資源。

get

 依資源名稱擷取 Cluster 資源。

getIamPolicy

 取得資源的存取控管政策。

list

 列出指定私有雲中的 Cluster 資源。

mountDatastore

 在叢集資源上掛接 Datastore

patch

 修改 Cluster 資源。

setIamPolicy

 設定指定資源的存取控管政策。

testIamPermissions

 傳回呼叫端對指定資源所擁有的權限。

unmountDatastore

 在叢集資源上卸載 Datastore