REST Resource: projects.locations.privateClouds.clusters

リソース: Cluster

プライベート クラウド内のクラスタ。

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。このクラスタのリソース名。リソース名は、https://cloud.google.com/apis/design/resource_names の規則に従ったスキームレス URI です。例: 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。プライベート クラウドに存在できる管理クラスタは 1 つだけで、最初のものである必要があります。
autoscalingSettings

object (AutoscalingSettings)

省略可。このクラスタに適用される自動スケーリングの構成。
uid

string

出力専用。システムが生成したリソースの固有識別子。
nodeTypeConfigs

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

必須。このクラスタ内のクラスタ ノードタイプのマップ。キーはノードタイプの正規識別子（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))

必須。クラスタに適用された自動スケーリング ポリシーを含むマップ。キーはポリシーの識別子です。次の要件を満たしている必要があります。

  • 1 ～ 63 個の英数字とハイフンのみを使用している
  • 先頭が英字である
  • ハイフン以外の文字で終わる
  • UUID の形式になっていない
  • RFC 1034（セクション 3.5）に準拠

現在、このマップには、コンピューティング ノードの自動スケーリング ポリシーを記述する要素を 1 つだけ含める必要があります。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
minClusterNodeCount

integer

省略可。クラスタ内の任意のタイプのノードの最小数。指定しない場合は、デフォルトの上限が適用されます。
maxClusterNodeCount

integer

省略可。クラスタ内の任意のタイプのノードの最大数。指定しない場合は、デフォルトの上限が適用されます。
coolDownPeriod

string (Duration format)

省略可。連続する自動スケーリング オペレーション間の最小期間。ノードの追加または削除が完全に完了すると、開始されます。指定しない場合のデフォルトは 30 分です。クールダウン期間は、分単位の整数（30 分、31 分、50 分、180 分など）で指定する必要があります。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

AutoscalingPolicy

自動スケーリング ポリシーは、リソース使用率に関する自動スケーリングの動作を記述します。使用率がそれぞれのしきい値のいずれかを超えると、スケールアウト オペレーションが開始されます。使用率がそれぞれのしきい値をすべて下回ると、スケールイン オペレーションが開始されます。

JSON 表現 
{
  "nodeTypeId": string,
  "scaleOutSize": integer,
  "cpuThresholds": {
    object (Thresholds)
  },
  "grantedMemoryThresholds": {
    object (Thresholds)
  },
  "consumedMemoryThresholds": {
    object (Thresholds)
  },
  "storageThresholds": {
    object (Thresholds)
  }
}
フィールド
nodeTypeId

string

必須。追加または削除するノードタイプの正規識別子。NodeType に対応しています。
scaleOutSize

integer

必須。スケールアウト オペレーション中にクラスタに追加するノードの数。ストレッチ クラスタの場合は 2 で割り切れる必要があります。スケールイン オペレーションでは、1 回の反復で 1 つのノード（ストレッチ クラスタの場合は 2 つ）のみが削除されます。
cpuThresholds

object (Thresholds)

省略可。CPU 使用率に関する使用率のしきい値。
grantedMemoryThresholds

object (Thresholds)

省略可。付与されたメモリ量に関する使用率のしきい値。
consumedMemoryThresholds

object (Thresholds)

省略可。消費されたメモリ量に関する使用率のしきい値。
storageThresholds

object (Thresholds)

省略可。使用済みストレージの量に関する使用率のしきい値。

しきい値

しきい値は、スケールアウトとスケールインのオペレーションをトリガーするリソースの使用率を定義します。

JSON 表現 
{
  "scaleOut": integer,
  "scaleIn": integer
}
フィールド
scaleOut

integer

必須。スケールアウト オペレーションをトリガーする使用率（パーセント）。
scaleIn

integer

必須。スケールイン オペレーションをトリガーする使用率（%）。

DatastoreMountConfig

Datastore マウント構成

JSON 表現 
{
  "fileShare": string,
  "datastore": string,
  "datastoreNetwork": {
    object (DatastoreNetwork)
  },
  "accessMode": enum (AccessMode),
  "nfsVersion": enum (NfsVersion),
  "servers": [
    string
  ]
}
フィールド
fileShare

string

出力専用。ファイル共有の名前。
datastore

string

必須。マウントするデータストアのリソース名。リソース名は、https://cloud.google.com/apis/design/resource_names の規則に従ったスキームレス URI です。例: 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

必須。サブネットのリソース名。リソース名は、https://cloud.google.com/apis/design/resource_names の規則に従ったスキーマレス URI です。例: projects/my-project/locations/us-central1/subnets/my-subnet
mtu

integer

省略可。MTU 値は、NFS トラフィックの VMKernel アダプタに設定されます。指定しない場合、MTU 1500 が使用されます。ジャンボ フレームを使用するには、この値を 8896 に設定します。この値は、NFS トラフィックのパフォーマンスに基づいて調整することをおすすめします。パフォーマンスは、fio（Flexible I/O Tester）ユーティリティなどのベンチマーク I/O ツールを使用して測定できます。
networkPeering

string

出力専用。プライベート クラウドのクライアントがファイル共有にアクセスするために使用するネットワーク ピアリングのリソース名。リソース名は、https://cloud.google.com/apis/design/resource_names の規則に従うスキーマレス URI です。例: projects/my-project/locations/us-central1/networkPeerings/my-network-peering
connectionCount

integer

省略可。connectionCount は、ESXi ホストの NFS クライアントから NFS サーバーへの複数の接続を設定するために使用されます。接続数が多いほど、データストアのパフォーマンスが向上します。clusters.mountDatastore API では、デフォルトで最大 4 つの接続が構成されます。ユーザーは connectionCount の値を 1 ～ 4 の範囲で設定できます。Connection_count は vsphere 8.0u1 以降でサポートされています。以前のバージョンでは、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 をマウント解除します