REST Resource: projects.locations.privateClouds

リソース: PrivateCloud

プライベート クラウド リソースを表します。タイプ STANDARD と TIME_LIMITED のプライベート クラウドはゾーンリソースで、STRETCHED プライベート クラウドはリージョン リソースです。

JSON 表現 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "expireTime": string,
  "state": enum (State),
  "networkConfig": {
    object (NetworkConfig)
  },
  "managementCluster": {
    object (ManagementCluster)
  },
  "description": string,
  "hcx": {
    object (Hcx)
  },
  "nsx": {
    object (Nsx)
  },
  "vcenter": {
    object (Vcenter)
  },
  "uid": string,
  "type": enum (Type)
}
フィールド
name

string

出力専用。ID。このプライベート クラウドのリソース名。リソース名は、https://cloud.google.com/apis/design/resource_names の規則に従ったスキームレス URI です。例: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
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"。
deleteTime

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"。
expireTime

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)

出力専用。リソースの状態。この列挙型には、必要に応じて新しい値が追加されることがあります。
networkConfig

object (NetworkConfig)

必須。プライベート クラウドのネットワーク構成。
managementCluster

object (ManagementCluster)

必須。入力専用。このプライベート クラウドの管理クラスタ。このフィールドは、プライベート クラウドの作成時にデフォルト クラスタの詳細を指定するために必要です。

プライベート クラウドの作成後に変更できないフィールドは、ManagementCluster.clusterId、ManagementCluster.nodeTypeId です。
description

string

このプライベート クラウドのユーザー指定の説明。
hcx

object (Hcx)

出力専用。HCX アプライアンス。
nsx

object (Nsx)

出力専用。NSX アプライアンス。
vcenter

object (Vcenter)

出力専用。vCenter アプライアンス。
uid

string

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

enum (Type)

省略可。プライベート クラウドのタイプ。デフォルトは STANDARD です。

状態

列挙型 State は、プライベート クラウドの可能な状態を定義します。

列挙型
STATE_UNSPECIFIED デフォルト値。この値は使用しないでください。
ACTIVE プライベート クラウドの準備が整いました。
CREATING プライベート クラウドが作成されています。
UPDATING プライベート クラウドが更新されています。
FAILED プライベート クラウドが失敗状態です。
DELETED プライベート クラウドは削除予定です。削除プロセスは、対応する削除取り消しメソッドを使用してキャンセルできます。
PURGING プライベート クラウドが完全に削除され、システムから削除されます。

NetworkConfig

ピアリングを行う必要があるコンシューマー プロジェクトのネットワーク構成。

JSON 表現 
{
  "managementCidr": string,
  "vmwareEngineNetwork": string,
  "vmwareEngineNetworkCanonical": string,
  "managementIpAddressLayoutVersion": integer,
  "dnsServerIp": string
}
フィールド
managementCidr

string

必須。VMware 管理アプライアンスで使用される管理 CIDR。
vmwareEngineNetwork

string

省略可。プライベート クラウドに接続されている VMware Engine ネットワークの相対リソース名。名前は projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} の形式で指定します。ここで、{project} はプロジェクト番号またはプロジェクト ID のいずれかです。
vmwareEngineNetworkCanonical

string

出力専用。VMware Engine ネットワークの正規名。形式は projects/{projectNumber}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} です。
managementIpAddressLayoutVersion

integer

出力専用。管理 IP アドレス範囲の IP アドレス レイアウト バージョン。使用可能なバージョンは次のとおりです。* managementIpAddressLayoutVersion=1: 一部の既存のプライベート クラウドで使用されている以前の IP アドレス レイアウトを示します。この機能は、すべての機能をサポートしていないため、新しいプライベート クラウドではサポートされなくなりました。* managementIpAddressLayoutVersion=2: 新しく作成されたすべてのプライベート クラウドで使用される最新の IP アドレス レイアウトを示します。このバージョンは、現在のすべての機能をサポートしています。
dnsServerIp

string

出力専用。Private Cloud の DNS サーバー IP。すべての DNS クエリをこのアドレスに転送して、vCenter、NSX-T Manager、ESXi ホストなどのプライベート クラウドの管理エンティティの名前解決を行うことができます。

ManagementCluster

管理クラスタの構成。

JSON 表現 
{
  "clusterId": string,
  "nodeTypeConfigs": {
    string: {
      object (NodeTypeConfig)
    },
    ...
  },
  "stretchedClusterConfig": {
    object (StretchedClusterConfig)
  }
}
フィールド
clusterId

string

必須。ユーザーが指定した新しい Cluster の識別子。識別子は次の要件を満たす必要があります。

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

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

必須。このクラスタ内のクラスタ ノードタイプのマップ。キーはノードタイプの正規識別子（NodeType に対応）です。

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

object (StretchedClusterConfig)

省略可。ストレッチ クラスタの構成。拡張プライベート クラウドに必要です。

Hcx

HCX Cloud Manager アプライアンスの詳細。

JSON 表現 
{
  "internalIp": string,
  "version": string,
  "state": enum (State),
  "fqdn": string
}
フィールド
internalIp

string

アプライアンスの内部 IP アドレス。
version

string

アプライアンスのバージョン。
state

enum (State)

出力専用。アプライアンスの状態。
fqdn

string

アプライアンスの完全修飾ドメイン名。

状態

アプライアンスの状態

列挙型
STATE_UNSPECIFIED アプライアンスの状態が指定されていません。これはデフォルト値です。
ACTIVE アプライアンスは動作しており、使用できます。
CREATING アプライアンスがデプロイされています。
ACTIVATING アプライアンスが有効になっています。

Nsx

NSX Manager アプライアンスの詳細。

JSON 表現 
{
  "internalIp": string,
  "version": string,
  "state": enum (State),
  "fqdn": string
}
フィールド
internalIp

string

アプライアンスの内部 IP アドレス。
version

string

アプライアンスのバージョン。
state

enum (State)

出力専用。アプライアンスの状態。
fqdn

string

アプライアンスの完全修飾ドメイン名。

状態

アプライアンスの状態

列挙型
STATE_UNSPECIFIED アプライアンスの状態が指定されていません。これはデフォルト値です。
ACTIVE アプライアンスは動作しており、使用できます。
CREATING アプライアンスがデプロイされています。

vCenter

vCenter Server 管理アプライアンスの詳細。

JSON 表現 
{
  "internalIp": string,
  "version": string,
  "state": enum (State),
  "fqdn": string
}
フィールド
internalIp

string

アプライアンスの内部 IP アドレス。
version

string

アプライアンスのバージョン。
state

enum (State)

出力専用。アプライアンスの状態。
fqdn

string

アプライアンスの完全修飾ドメイン名。

状態

アプライアンスの状態

列挙型
STATE_UNSPECIFIED アプライアンスの状態が指定されていません。これはデフォルト値です。
ACTIVE アプライアンスは動作しており、使用できます。
CREATING アプライアンスがデプロイされています。

タイプ

列挙型はプライベート クラウドの種類を定義します。

列挙型
STANDARD Standard Private は、3 つ以上のノードを持つゾーン リソースです。デフォルトのタイプ。
TIME_LIMITED 有効期限付きのプライベート クラウドはゾーン リソースであり、ノードを 1 つしか持つことができず、有効期間が限られています。定義された期間後に削除されます。3 つ以上のノードに拡張することで、標準のプライベート クラウドに変換できます。
STRETCHED 拡張プライベート クラウドは、冗長性のあるリージョン リソースです。最小ノード数は 6 で、ノード数は偶数にする必要があります。

メソッド

create

 指定されたプロジェクトとロケーションに新しい PrivateCloud リソースを作成します。

delete

 PrivateCloud リソースの削除をスケジュールします。

get

 リソース名で PrivateCloud リソースを取得します。

getDnsForwarding

 DnsForwarding 構成の詳細を取得します。

getIamPolicy

 リソースのアクセス制御ポリシーを取得します。

list

 指定されたプロジェクトとロケーションの PrivateCloud リソースの一覧を取得します。

patch

 PrivateCloud リソースを変更します。

privateCloudDeletionNow

 現在削除済み（復元可能）状態のプライベート クラウドの削除を高速化します。削除済み（復元可能）状態の PrivateCloud リソースでは、PrivateCloud.state が SOFT_DELETED に設定され、PrivateCloud.expireTime が削除を取り消せなくなる時刻に設定されます。

resetNsxCredentials

 NSX アプライアンスの認証情報をリセットします。

resetVcenterCredentials

 Vcenter アプライアンスの認証情報をリセットします。

setIamPolicy

 指定したリソースにアクセス制御ポリシーを設定します。

showNsxCredentials

 NSX アプライアンスの認証情報の詳細を取得します。

showVcenterCredentials

 vCenter アプライアンスの認証情報の詳細を取得します。

testIamPermissions

 指定したリソースに対して呼び出し元が持っている権限を返します。

undelete

 DeletePrivateCloud によって削除がスケジュールされていたプライベート クラウドを復元します。

updateDnsForwarding

 関連付けられたドメインなど、DnsForwarding 構成のパラメータを更新します。