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

仅限输出。标识符。相应私有云的资源名称。资源名称是无方案 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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_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

仅限输出。私有云的 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)

可选。扩展集群的配置。对于 STRETCHED 私有云，这是必需的。

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 标准专用集群是可用区级资源，包含 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 配置的参数，例如关联的网域。