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。這個私有雲的資源名稱。資源名稱是無配置的 URI，遵循 https://cloud.google.com/apis/design/resource_names 中的慣例。例如：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)

這是必要旗標，僅限輸入。這個私有雲的管理叢集。建立私有雲時，必須填寫這個欄位，提供預設叢集的詳細資料。

建立 Private Cloud 後，下列欄位就無法變更：ManagementCluster.clusterId、ManagementCluster.nodeTypeId。
description

string

這個私有雲的使用者提供說明。
hcx

object (Hcx)

僅供輸出。HCX 設備。
nsx

object (Nsx)

僅供輸出。NSX 設備。
vcenter

object (Vcenter)

僅供輸出。vCenter 裝置。
uid

string

僅供輸出。系統為資源產生的專屬 ID。
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 的使用者提供 ID。ID 必須符合下列規定：

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

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

這是必要旗標，這個叢集中的叢集節點類型對應表，其中鍵是節點類型的標準 ID (對應至 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 正在部署設備。

類型

Enum Type 定義私有雲類型。

列舉
STANDARD 標準私有叢集是區域性資源，具有 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 設定的參數，例如相關聯的網域。