索引
GDCHardwareManagement(接口)ChangeLogEntry(消息)Comment(消息)Contact(消息)CreateCommentRequest(消息)CreateHardwareGroupRequest(消息)CreateHardwareRequest(消息)CreateOrderRequest(消息)CreateSiteRequest(消息)CreateZoneRequest(消息)DeleteHardwareGroupRequest(消息)DeleteHardwareRequest(消息)DeleteOrderRequest(消息)DeleteSiteRequest(消息)DeleteZoneRequest(消息)Dimensions(消息)Entity(枚举)GetChangeLogEntryRequest(消息)GetCommentRequest(消息)GetHardwareGroupRequest(消息)GetHardwareRequest(消息)GetOrderRequest(消息)GetSiteRequest(消息)GetSkuRequest(消息)GetZoneRequest(消息)Hardware(消息)Hardware.DiskInfo(消息)Hardware.MacAddress(消息)Hardware.MacAddress.AddressType(枚举)Hardware.MachineInfo(消息)Hardware.State(枚举)HardwareConfig(消息)HardwareGroup(消息)HardwareGroup.State(枚举)HardwareInstallationInfo(消息)HardwareInstallationInfo.RackType(枚举)HardwareLocation(消息)HardwarePhysicalInfo(消息)HardwarePhysicalInfo.Amperes(枚举)HardwarePhysicalInfo.NetworkUplinkType(枚举)HardwarePhysicalInfo.PowerReceptacleType(枚举)HardwarePhysicalInfo.Voltage(枚举)ListChangeLogEntriesRequest(消息)ListChangeLogEntriesResponse(消息)ListCommentsRequest(消息)ListCommentsResponse(消息)ListHardwareGroupsRequest(消息)ListHardwareGroupsResponse(消息)ListHardwareRequest(消息)ListHardwareResponse(消息)ListOrdersRequest(消息)ListOrdersResponse(消息)ListSitesRequest(消息)ListSitesResponse(消息)ListSkusRequest(消息)ListSkusResponse(消息)ListZonesRequest(消息)ListZonesResponse(消息)OperationMetadata(消息)Order(消息)Order.DeploymentType(枚举)Order.State(枚举)Order.Type(枚举)OrganizationContact(消息)PowerSupply(枚举)RackSpace(消息)RecordActionOnCommentRequest(消息)RecordActionOnCommentRequest.ActionType(枚举)SignalZoneStateRequest(消息)SignalZoneStateRequest.ProvisioningStateSignal(枚举)SignalZoneStateRequest.StateSignal(枚举)Site(消息)Sku(消息)Sku.Range(消息)Sku.Type(枚举)SkuConfig(消息)SkuInstance(消息)SubmitOrderRequest(消息)SubmitOrderRequest.Type(枚举)Subnet(消息)SubscriptionConfig(消息)SubscriptionConfig.SubscriptionState(枚举)TimePeriod(消息)UpdateHardwareGroupRequest(消息)UpdateHardwareRequest(消息)UpdateOrderRequest(消息)UpdateSiteRequest(消息)UpdateZoneRequest(消息)Zone(消息)Zone.ProvisioningState(枚举)Zone.State(枚举)ZoneNetworkConfig(消息)
GDCHardwareManagement
GDC Hardware Management 服务。
| CreateComment |
|---|
|
针对订单创建新评论。
|
| CreateHardware |
|---|
|
在给定的项目和位置中创建新硬件。
|
| CreateHardwareGroup |
|---|
|
在给定订单中创建新的硬件组。
|
| CreateOrder |
|---|
|
在给定的项目和位置中创建新订单。
|
| CreateSite |
|---|
|
在给定的项目和位置中创建新网站。
|
| CreateZone |
|---|
|
在给定的项目和位置中创建新区域。
|
| DeleteHardware |
|---|
|
删除硬件。
|
| DeleteHardwareGroup |
|---|
|
删除硬件组。
|
| DeleteOrder |
|---|
|
删除订单。
|
| DeleteSite |
|---|
|
删除网站。
|
| DeleteZone |
|---|
|
删除可用区。
|
| GetChangeLogEntry |
|---|
|
获取订单变更的详细信息。
|
| GetComment |
|---|
|
获取评论的内容。
|
| GetHardware |
|---|
|
获取硬件详细信息。
|
| GetHardwareGroup |
|---|
|
获取硬件组的详细信息。
|
| GetOrder |
|---|
|
获取订单的详细信息。
|
| GetSite |
|---|
|
获取网站的详细信息。
|
| GetSku |
|---|
|
获取 SKU 的详细信息。
|
| GetZone |
|---|
|
获取可用区的详细信息。
|
| ListChangeLogEntries |
|---|
|
列出对订单做出的更改。
|
| ListComments |
|---|
|
列出订单的评论。
|
| ListHardware |
|---|
|
列出给定项目和位置中的硬件。
|
| ListHardwareGroups |
|---|
|
按指定顺序列出硬件组。
|
| ListOrders |
|---|
|
列出给定项目和位置中的订单。
|
| ListSites |
|---|
|
列出给定项目和位置中的网站。
|
| ListSkus |
|---|
|
列出给定项目和位置的 SKU。
|
| ListZones |
|---|
|
列出给定项目和位置中的可用区。
|
| RecordActionOnComment |
|---|
|
记录对评论执行的操作。如果请求中指定的操作为 READ,则评论中的查看时间会设置为收到请求的时间。如果评论已标记为已读,则后续调用将被忽略。如果操作为 UNREAD,则会从评论中清除查看时间。
|
| SignalZoneState |
|---|
|
指示可用区的状态。
|
| SubmitOrder |
|---|
|
提交订单。
|
| UpdateHardware |
|---|
|
更新硬件参数。
|
| UpdateHardwareGroup |
|---|
|
更新硬件组的参数。
|
| UpdateOrder |
|---|
|
更新订单的参数。
|
| UpdateSite |
|---|
|
更新网站的参数。
|
| UpdateZone |
|---|
|
更新相应地区的参数。
|
ChangeLogEntry
对订单所做更改的日志条目。
| 字段 | |
|---|---|
name |
标识符。相应变更日志条目的名称。格式: |
create_time |
仅限输出。相应更改日志条目的创建时间。 |
labels |
可选。与此更改日志条目关联的标签(以键值对形式表示)。如需详细了解标签,请参阅创建和管理标签。 |
log |
仅限输出。相应日志条目的内容。 |
评论
订单备注。
| 字段 | |
|---|---|
name |
标识符。相应评论的名称。格式: |
create_time |
仅限输出。相应评论的创建时间。 |
labels |
可选。与相应评论相关联的标签(以键值对的形式)。如需详细了解标签,请参阅创建和管理标签。 |
author |
仅限输出。相应评论作者的用户名。系统会根据创建评论时使用的凭据自动填充此字段。 |
text |
必需。相应评论的文本。文本长度必须小于或等于 1000 个字符。 |
customer_viewed_time |
仅限输出。客户首次查看相应评论的时间戳。如果评论未被查看,则此时间戳将处于未设置状态。 |
author_entity |
仅限输出。作者所属的实体。 |
联系人
联系人的联系信息。
| 字段 | |
|---|---|
given_name |
必需。联系人的名字。 |
family_name |
可选。联系人的姓氏。 |
email |
必需。联系人的电子邮件地址。 |
phone |
必需。联系人的电话号码。 |
time_zone |
可选。联系人的时区。 |
reachable_times[] |
可选。相应联系人可联系的时间段。如果此字段为空,则表示随时都可以联系到相应联系人。 |
CreateCommentRequest
创建评论的请求。
| 字段 | |
|---|---|
parent |
必需。要针对哪个订单创建评论。格式: |
comment_id |
可选。用于在父级范围内唯一标识 Comment 的 ID。此字段应最多包含 63 个字符,且必须以小写字符开头。只能使用小写字符、数字和 系统会忽略请求中的 comment.name 字段。 |
comment |
必需。要创建的评论。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
CreateHardwareGroupRequest
创建硬件组的请求。
| 字段 | |
|---|---|
parent |
必需。创建硬件组的顺序。格式: |
hardware_group_id |
可选。用于在父级范围内唯一标识 HardwareGroup 的 ID。此字段应最多包含 63 个字符,且必须以小写字符开头。只能使用小写字符、数字和 系统会忽略请求中的 hardware_group.name 字段。 |
hardware_group |
必需。要创建的硬件组。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
CreateHardwareRequest
创建硬件的请求。
| 字段 | |
|---|---|
parent |
必需。用于创建硬件的项目和位置。格式: |
hardware_id |
可选。用于在父级范围内唯一标识硬件的 ID。此字段应最多包含 63 个字符,且必须以小写字符开头。只能使用小写字符、数字和 系统会忽略请求中的 hardware.name 字段。 |
hardware |
必需。要创建的资源。 |
CreateOrderRequest
创建订单的请求。
| 字段 | |
|---|---|
parent |
必需。要在其中创建订单的项目和位置。格式: |
order_id |
可选。用于在父级范围内唯一标识订单的 ID。此字段应最多包含 63 个字符,且必须以小写字符开头。只能使用小写字符、数字和 系统会忽略请求中的 order.name 字段。 |
order |
必需。要创建的订单。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
CreateSiteRequest
创建网站的请求。
| 字段 | |
|---|---|
parent |
必需。要在其中创建网站的项目和位置。格式: |
site_id |
可选。用于在父级范围内唯一标识网站的 ID。此字段应最多包含 63 个字符,且必须以小写字符开头。只能使用小写字符、数字和 请求中的 site.name 字段将被忽略。 |
site |
必需。要创建的网站。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
CreateZoneRequest
创建区域的请求。
| 字段 | |
|---|---|
parent |
必需。要在其中创建可用区的项目和位置。格式: |
zone_id |
可选。用于在父级范围内唯一标识相应广告资源的 ID。此字段应最多包含 63 个字符,且必须以小写字符开头。只能使用小写字符、数字和 系统会忽略请求中的 zone.name 字段。 |
zone |
必需。要创建的可用区。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
DeleteHardwareGroupRequest
用于删除硬件组的请求。
| 字段 | |
|---|---|
name |
必需。硬件组的名称。格式: |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
DeleteHardwareRequest
删除硬件的请求。
| 字段 | |
|---|---|
name |
必需。硬件的名称。格式: |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
DeleteOrderRequest
用于删除订单的请求。
| 字段 | |
|---|---|
name |
必需。订单的名称。格式: |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
force |
可选。用于删除订单中任何嵌套资源(例如 HardwareGroup)的选项。如果为 true,则此订单的所有嵌套资源也会被删除。否则,只有当订单没有嵌套资源时,请求才会成功。 |
DeleteSiteRequest
用于删除网站的请求。
| 字段 | |
|---|---|
name |
必需。网站的名称。格式: |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
DeleteZoneRequest
用于删除可用区的请求。
| 字段 | |
|---|---|
name |
必需。相应时区的名称。格式: |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
维度
表示对象的尺寸。
| 字段 | |
|---|---|
width_inches |
必需。宽度(以英寸为单位)。 |
height_inches |
必需。身高,以英寸为单位。 |
depth_inches |
必需。深度(以英寸为单位)。 |
实体
实体用于表示组织或当事方。
| 枚举 | |
|---|---|
ENTITY_UNSPECIFIED |
实体未指定。 |
GOOGLE |
Google。 |
CUSTOMER |
客户。 |
VENDOR |
供应商。 |
GetChangeLogEntryRequest
获取更改日志条目的请求。
| 字段 | |
|---|---|
name |
必需。更改日志条目的名称。格式: |
GetCommentRequest
获取评论的请求。
| 字段 | |
|---|---|
name |
必需。评论的名称。格式: |
GetHardwareGroupRequest
获取硬件组的请求。
| 字段 | |
|---|---|
name |
必需。硬件组的名称。格式: |
GetHardwareRequest
获取硬件的请求。
| 字段 | |
|---|---|
name |
必需。硬件的名称。格式: |
GetOrderRequest
获取订单的请求。
| 字段 | |
|---|---|
name |
必需。资源的名称 |
GetSiteRequest
获取网站的请求。
| 字段 | |
|---|---|
name |
必需。网站的名称。格式: |
GetSkuRequest
获取 SKU 的请求。
| 字段 | |
|---|---|
name |
必需。相应 SKU 的名称。格式: |
GetZoneRequest
获取地区的请求。
| 字段 | |
|---|---|
name |
必需。相应时区的名称。格式: |
硬件
安装在现场的硬件实例。
| 字段 | |
|---|---|
name |
标识符。相应硬件的名称。格式: |
display_name |
可选。相应硬件的显示名称。 |
create_time |
仅限输出。相应硬件的创建时间。 |
update_time |
仅限输出。相应硬件上次更新的时间。 |
labels |
可选。与相应硬件相关联的标签(以键值对的形式)。如需详细了解标签,请参阅创建和管理标签。 |
order |
必需。相应硬件所属订单的名称。格式: |
hardware_group |
仅限输出。相应硬件所属的硬件组的名称。格式: |
site |
必需。相应硬件所属网站的名称。格式: |
state |
仅限输出。相应硬件的当前状态。 |
ciq_uri |
仅限输出。指向相应硬件的客户信息收集问卷 (CIQ) 工作表的链接。 |
config |
必需。相应硬件的配置。 |
estimated_installation_date |
仅限输出。相应硬件的预计安装日期。 |
physical_info |
可选。相应硬件的物理属性。 |
installation_info |
可选。有关安装此硬件的信息。 |
zone |
必需。相应硬件所属可用区的名称。格式: |
requested_installation_date |
可选。相应硬件的请求安装日期。如果未指定,则在提交订单时,系统会根据订单的 fulfillment_time 自动填充此字段;在接受订单时,系统会根据 HardwareGroup 的 requested_installation_date 自动填充此字段。 |
actual_installation_date |
仅限输出。相应硬件的实际安装日期。由 Google 填写。 |
machine_infos[] |
仅限输出。启动所需的每台机器资产信息。 |
DiskInfo
有关机器上各个磁盘的信息。
| 字段 | |
|---|---|
manufacturer |
仅限输出。磁盘制造商。 |
slot |
仅限输出。磁盘插槽编号。 |
serial_number |
仅限输出。磁盘序列号。 |
psid |
仅限输出。磁盘 PSID。 |
part_number |
仅限输出。磁盘部件号。 |
model_number |
仅限输出。磁盘型号。 |
MacAddress
用于描述机器的 MAC 地址的消息。
| 字段 | |
|---|---|
address |
仅限输出。地址字符串。 |
type |
仅限输出。相应 MAC 地址的地址类型。 |
ipv4_address |
仅限输出。与 MAC 地址关联的静态 IP 地址(如果使用)。仅适用于虚拟 MAC 地址类型。 |
AddressType
用于表示不同类型的 MAC 地址的枚举。
| 枚举 | |
|---|---|
ADDRESS_TYPE_UNSPECIFIED |
未指定地址类型。 |
NIC |
网络接口卡的地址。 |
BMC |
基板管理控制器的地址。 |
VIRTUAL |
虚拟接口的地址。 |
MachineInfo
供应商在启动期间提供的有关各个机器的信息。
| 字段 | |
|---|---|
service_tag |
仅限输出。机器服务编号。 |
mac_addresses[] |
仅限输出。每个关联的 MAC 地址。 |
name |
仅限输出。机器名称。 |
disk_infos[] |
仅限输出。每个已安装磁盘的信息。 |
州
硬件的有效状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
硬件状态未指定。 |
ADDITIONAL_INFO_NEEDED |
需要客户提供更多信息才能继续处理。 |
BUILDING |
Google 已开始为此硬件构建硬件。 |
SHIPPING |
硬件已构建完毕,正在配送中。 |
INSTALLING |
正在安装硬件。 |
INSTALLED |
硬件已安装。 |
FAILED |
发生了错误,需要客户介入。 |
HardwareConfig
GDC 硬件的配置。
| 字段 | |
|---|---|
sku |
必需。对相应硬件的 SKU 的引用。这可以指向特定 SKU 修订版本,格式为 |
power_supply |
必需。相应硬件的电源类型。 |
subscription_duration_months |
可选。硬件的订阅时长(以月为单位)。 |
HardwareGroup
一组属于同一订单、具有相同 SKU 且交付到同一地点的硬件。
| 字段 | |
|---|---|
name |
标识符。相应硬件组的名称。格式: |
create_time |
仅限输出。相应硬件组的创建时间。 |
update_time |
仅限输出。相应硬件组的上次更新时间。 |
labels |
可选。与此硬件组关联的标签(以键值对的形式)。如需详细了解标签,请参阅创建和管理标签。 |
hardware_count |
必需。相应 HardwareGroup 中的硬件数量。 |
config |
必需。相应 HardwareGroup 中硬件的配置。 |
site |
必需。相应 HardwareGroup 中的硬件将交付到的站点的名称。格式: |
state |
仅限输出。相应 HardwareGroup 的当前状态。 |
zone |
可选。相应 HardwareGroup 中的硬件所属可用区的名称。格式: |
requested_installation_date |
可选。相应 HardwareGroup 中硬件的请求安装日期。由客户填写。 |
州
HardwareGroup 的有效状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
硬件组的状态未指定。 |
ADDITIONAL_INFO_NEEDED |
需要客户提供更多信息才能继续处理。 |
BUILDING |
Google 已开始为相应 HardwareGroup 构建硬件。 |
SHIPPING |
硬件已构建完毕,正在配送中。 |
INSTALLING |
正在安装硬件。 |
PARTIALLY_INSTALLED |
HardwareGroup 中的部分硬件已安装。 |
INSTALLED |
HardwareGroup 中的所有硬件均已安装。 |
FAILED |
发生了错误,需要客户介入。 |
HardwareInstallationInfo
有关安装硬件的信息。
| 字段 | |
|---|---|
rack_location |
必需。机架在场地中的位置,例如 2 楼 201 室第 7 排第 3 个机架。 |
power_distance_meters |
必需。与电源插座的距离(以米为单位)。 |
switch_distance_meters |
必需。与网络交换机的距离(以米为单位)。 |
rack_unit_dimensions |
必需。机架单元的尺寸。 |
rack_space |
必需。为硬件分配的机架空间。 |
rack_type |
必需。机架类型。 |
RackType
有效的机架类型。
| 枚举 | |
|---|---|
RACK_TYPE_UNSPECIFIED |
机架类型未指定。 |
TWO_POST |
双立柱机架。 |
FOUR_POST |
四立柱机架。 |
HardwareLocation
表示一个或多个硬件的位置。
| 字段 | |
|---|---|
site |
必需。硬件所在的网站的名称。格式: |
rack_location |
必需。机架在场地中的位置,例如 2 楼 201 室第 7 排第 3 个机架。 |
rack_space[] |
可选。硬件在机架中占用的空间。如果未设置,则假定此位置是整个机架。 |
HardwarePhysicalInfo
硬件的物理属性。
| 字段 | |
|---|---|
power_receptacle |
必需。电源插座类型。 |
network_uplink |
必需。上行网络连接的类型。 |
voltage |
必需。电源电压。 |
amperes |
必需。电源的安培数。 |
安培
有效的安培值。
| 枚举 | |
|---|---|
AMPERES_UNSPECIFIED |
未指定电流。 |
AMPERES_15 |
15A. |
NetworkUplinkType
有效的网络上行类型。
| 枚举 | |
|---|---|
NETWORK_UPLINK_TYPE_UNSPECIFIED |
未指定网络上行类型。 |
RJ_45 |
RJ-45。 |
PowerReceptacleType
有效的电源插座类型。
| 枚举 | |
|---|---|
POWER_RECEPTACLE_TYPE_UNSPECIFIED |
设施插头类型未指定。 |
NEMA_5_15 |
NEMA 5-15。 |
C_13 |
C13. |
STANDARD_EU |
标准欧式插座。 |
电压
有效电压值。
| 枚举 | |
|---|---|
VOLTAGE_UNSPECIFIED |
电压未指定。 |
VOLTAGE_110 |
120V。 |
VOLTAGE_220 |
220V。 |
ListChangeLogEntriesRequest
列出更改日志条目的请求。
| 字段 | |
|---|---|
parent |
必需。列出更改日志条目的顺序。格式: |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。过滤条件。请参阅 AIP-160。 |
order_by |
可选。有关如何对结果进行排序的提示。 |
ListChangeLogEntriesResponse
更改日志条目的列表。
| 字段 | |
|---|---|
change_log_entries[] |
更改日志条目的列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListCommentsRequest
列出评论的请求。
| 字段 | |
|---|---|
parent |
必需。要列出评论的订单。格式: |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。过滤条件。请参阅 AIP-160。 |
order_by |
可选。有关如何对结果进行排序的提示。 |
ListCommentsResponse
列出评论的请求。
| 字段 | |
|---|---|
comments[] |
评论列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListHardwareGroupsRequest
列出硬件组的请求。
| 字段 | |
|---|---|
parent |
必需。列出硬件组的顺序。格式: |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。过滤条件。请参阅 AIP-160。 |
order_by |
可选。有关如何对结果进行排序的提示。 |
ListHardwareGroupsResponse
硬件组列表。
| 字段 | |
|---|---|
hardware_groups[] |
硬件组列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListHardwareRequest
列出硬件的请求。
| 字段 | |
|---|---|
parent |
必需。要列出硬件的项目和位置。格式: 如需列出所有位置的硬件,请将位置替换为 |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。过滤条件。请参阅 AIP-160。 |
order_by |
可选。有关如何对结果进行排序的提示。 |
ListHardwareResponse
硬件列表。
| 字段 | |
|---|---|
hardware[] |
硬件列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。仅用于对通配符位置 |
ListOrdersRequest
列出订单的请求。
| 字段 | |
|---|---|
parent |
必需。要列出订单的项目和位置。格式: 如需列出所有位置的订单,请将位置替换为 |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。过滤条件。请参阅 AIP-160。 |
order_by |
可选。有关如何对结果进行排序的提示。 |
ListOrdersResponse
订单列表。
| 字段 | |
|---|---|
orders[] |
订单列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。仅用于对通配符位置 |
ListSitesRequest
列出网站的请求。
| 字段 | |
|---|---|
parent |
必需。要列出网站的项目和位置。格式: 如需列出所有位置的网站,请将位置替换为 |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。过滤条件。请参阅 AIP-160。 |
order_by |
可选。有关如何对结果进行排序的提示。 |
ListSitesResponse
网站列表。
| 字段 | |
|---|---|
sites[] |
网站列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。仅用于对通配符位置 |
ListSkusRequest
列出 SKU 的请求。
| 字段 | |
|---|---|
parent |
必需。要列出 SKU 的项目和位置。格式: 如需列出所有位置的 SKU,请将位置替换为 |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。过滤条件。请参阅 AIP-160。 |
order_by |
可选。有关如何对结果进行排序的提示。 |
ListSkusResponse
SKU 的列表。
| 字段 | |
|---|---|
skus[] |
SKU 列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。仅用于对通配符位置 |
ListZonesRequest
列出可用区的请求。
| 字段 | |
|---|---|
parent |
必需。要列出可用区的项目和位置。格式: 如需列出所有位置中的可用区,请将位置替换为 |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。过滤条件。请参阅 AIP-160。 |
order_by |
可选。有关如何对结果进行排序的提示。 |
ListZonesResponse
可用区列表。
| 字段 | |
|---|---|
zones[] |
可用区列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。仅用于对通配符位置 |
OperationMetadata
表示长时间运行的操作的元数据。
| 字段 | |
|---|---|
create_time |
仅供输出。操作的创建时间。 |
end_time |
仅供输出。操作完成运行的时间。 |
target |
仅限输出。由服务器定义的操作目标的资源路径。 |
verb |
仅限输出。操作执行的谓词。 |
status_message |
仅限输出。人类可读的操作状态(如果有)。 |
requested_cancellation |
仅限输出。标识用户是否已请求取消操作。已成功取消的操作具有 [Operation.error][] 值且 |
api_version |
仅限输出。用于启动操作的 API 版本。 |
订单
GDC 硬件的订单。
| 字段 | |
|---|---|
name |
标识符。相应订单的名称。格式: |
display_name |
可选。相应订单的显示名称。 |
create_time |
仅限输出。相应订单的创建时间。 |
update_time |
仅限输出。相应订单的上次更新时间。 |
labels |
可选。与相应订单关联的标签(以键值对的形式)。如需详细了解标签,请参阅创建和管理标签。 |
state |
仅限输出。相应订单的状态。创建订单时,状态将设置为“草稿”。 |
organization_contact |
必需。客户联系信息。 |
target_workloads[] |
可选。相应订单所针对的客户指定的相关工作负载。此值必须包含不超过 20 个元素,且每个元素的长度不得超过 50 个字符。 |
customer_motivation |
必需。有关客户下单动机的信息。此字段的长度必须小于或等于 1,000 个字符。 |
fulfillment_time |
必需。客户指定的订单完成期限。 |
region_code |
必需。将部署相应订单的 Unicode CLDR 区域代码。如需查看有效的 CLDR 区域代码列表,请参阅语言子标签注册表。 |
order_form_uri |
仅限输出。指向订购单的链接。 |
type |
仅限输出。相应订单的类型。 |
submit_time |
仅限输出。提交订单的时间。在提交订单时自动填充为当前时间。 |
billing_id |
仅限输出。要为此订单收取费用的 Google Cloud 结算 ID。 |
existing_hardware[] |
可选。将在此订单中移除的现有硬件。注意:除非另有约定,否则移除的所有硬件都将回收。 |
deployment_type |
仅限输出。相应订单的部署类型。 |
actual_installation_date |
仅限输出。相应订单的实际安装日期。 |
estimated_installation_date |
仅限输出。相应订单的预计安装日期。 |
DeploymentType
部署的有效类型。
| 枚举 | |
|---|---|
DEPLOYMENT_TYPE_UNSPECIFIED |
部署类型未指定。 |
FULL_PRODUCTION |
具有 SLO 的 Prod 部署。 |
PROOF_OF_CONCEPT |
部署,提供尽力支持,但没有 SLO。 |
INTERNAL |
内部部署,提供尽力而为的支持,没有 SLO。 |
CUSTOMER_LAB |
我们支持的客户实验环境部署,就像支持生产环境一样。 |
州
订单的有效状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
订单状态未指定。 |
DRAFT |
订单正在由客户起草,尚未提交。 |
SUBMITTED |
订单已提交给 Google。 |
INFO_COMPLETE |
客户为完成订单而需要提供的所有信息均已提供。 |
ACCEPTED |
Google 已接受订单。 |
ADDITIONAL_INFO_NEEDED |
订单需要客户提供更多信息。 |
BUILDING |
Google 已开始为相应订单制造硬件。 |
SHIPPING |
硬件已构建完毕,正在配送中。 |
INSTALLING |
正在安装硬件。 |
FAILED |
处理订单时出错,需要客户介入。 |
PARTIALLY_COMPLETED |
订单已部分完成,即部分硬件已送达并安装。 |
COMPLETED |
订单已完成。 |
CANCELLED |
订单已取消。 |
类型
订单的有效类型。
| 枚举 | |
|---|---|
TYPE_UNSPECIFIED |
订单类型未指定。 |
PAID |
由客户支付。 |
POC |
面向客户的概念验证。 |
UNPAID |
未结算。 |
OrganizationContact
客户组织的联系信息。
| 字段 | |
|---|---|
address |
必需。组织的地址。 |
email |
可选。组织的电子邮件地址。 |
phone |
可选。组织的手机号码。 |
contacts[] |
必需。相应营业地点的组织中的各个联系人。 |
PowerSupply
电源选项。
| 枚举 | |
|---|---|
POWER_SUPPLY_UNSPECIFIED |
电源未指定。 |
POWER_SUPPLY_AC |
AC 电源。 |
POWER_SUPPLY_DC |
直流电源。 |
RackSpace
表示机架中的连续空间。
| 字段 | |
|---|---|
start_rack_unit |
必需。机架空间的第一个机架单元(含)。 |
end_rack_unit |
必需。机架空间的最后一个机架单元(含)。 |
RecordActionOnCommentRequest
用于记录对评论执行的操作的请求。
| 字段 | |
|---|---|
name |
必需。评论的名称。格式: |
action_type |
必需。所记录操作的操作类型。 |
ActionType
评论的有效操作类型。
| 枚举 | |
|---|---|
ACTION_TYPE_UNSPECIFIED |
未指定操作。 |
READ |
将评论标记为已读。 |
UNREAD |
将评论标记为未读。 |
SignalZoneStateRequest
用于发出可用区状态信号的请求。
| 字段 | |
|---|---|
name |
必需。相应时区的名称。格式: |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
state_signal |
可选。要为此可用区发送的状态信号。必须设置 state_signal 或 provisioning_state_signal,但不能同时设置这两者。 |
provisioning_state_signal |
可选。要为此地区发送的配置状态信号。必须设置 state_signal 或 provisioning_state_signal,但不能同时设置这两者。 |
step |
可选。正在执行的步骤。当 state_signal 为 FACTORY_TURNUP_CHECKS_STARTED 或 FACTORY_TURNUP_CHECKS_FAILED 时,提供更精细的状态。 |
details |
可选。其他详细信息,例如当 state_signal 为 FACTORY_TURNUP_CHECKS_FAILED 时的错误消息。 |
ProvisioningStateSignal
可用区的有效配置状态信号。
| 枚举 | |
|---|---|
PROVISIONING_STATE_SIGNAL_UNSPECIFIED |
未指定配置状态信号。 |
PROVISIONING_IN_PROGRESS |
正在进行配置。 |
PROVISIONING_COMPLETE |
配置已完成。 |
StateSignal
可用区的有效状态信号。
| 枚举 | |
|---|---|
STATE_SIGNAL_UNSPECIFIED |
相应区域的状态信号未指定。 |
FACTORY_TURNUP_CHECKS_STARTED |
工厂启动检查已开始。 |
FACTORY_TURNUP_CHECKS_PASSED |
相应区域已准备好进行网站启动。 |
READY_FOR_SITE_TURNUP |
相应区域已准备好进行网站启动。已废弃,但未删除。 |
FACTORY_TURNUP_CHECKS_FAILED |
相应功能区在出厂启动检查中失败。 |
网站
将安装硬件的实际地点。
| 字段 | |
|---|---|
name |
标识符。网站的名称。格式: |
display_name |
可选。相应网站的显示名称。 |
description |
可选。相应网站的说明。 |
create_time |
仅限输出。相应网站的创建时间。 |
update_time |
仅限输出。相应网站的上次更新时间。 |
labels |
可选。与相应网站相关联的标签(以键值对的形式)。如需详细了解标签,请参阅创建和管理标签。 |
organization_contact |
必需。相应网站的联系信息。 |
google_maps_pin_uri |
可选。网站的 Google 地图地址位置的网址。示例值为 |
access_times[] |
可选。网站可访问的时间段。如果此字段为空,则表示相应网站随时可访问。 Google 会使用此字段来安排初始安装以及任何后续硬件维护。您可以随时更新此设置。例如,如果初始安装是在非工作时间请求的,但维护应在正常工作时间执行,则您应在初始安装完成后更新访问时间。 |
notes |
可选。关于此场地的任何其他备注。请提供以下方面的信息:- 安全或访问限制- 影响技术人员访问现场的任何法规- 移动设备所需的任何特殊流程或审批- 在现场访问期间是否有代表在场 |
customer_site_id |
可选。相应网站的客户定义标识符。此 ID 可用于在客户自己的系统中标识相应网站。 |
SKU
GDC 硬件的库存量单位 (SKU)。
| 字段 | |
|---|---|
name |
标识符。相应 SKU 的名称。格式: |
display_name |
仅限输出。相应 SKU 的显示名称。 |
create_time |
仅限输出。相应 SKU 的创建时间。 |
update_time |
仅限输出。相应 SKU 的上次更新时间。 |
config |
仅限输出。相应 SKU 的配置。 |
instances[] |
仅限输出。相应 SKU 的可用实例数。此字段应用于检查 SKU 的供应情况。 |
description |
仅限输出。相应 SKU 的说明。 |
revision_id |
仅限输出。SKU 修订版本 ID。每当 |
is_active |
仅限输出。标志,用于指示相应修订版本是否处于有效状态。只有有效修订版本才能用于新订单。 |
type |
仅限输出。相应 SKU 的类型。 |
vcpu_count |
仅限输出。与相应 SKU 关联的 vCPU 数量。 |
hardware_count_ranges[] |
仅限输出。相应 SKU 允许在地区中使用的硬件数量的包含性范围。 |
范围
包含性范围。
| 字段 | |
|---|---|
min |
范围的最小值。 |
max |
范围的最大值。 |
类型
SKU 的有效类型。
| 枚举 | |
|---|---|
TYPE_UNSPECIFIED |
SKU 的类型未指定。此值不允许。 |
RACK |
机架 SKU。 |
SERVER |
服务器 SKU。 |
SkuConfig
SKU 的配置。
| 字段 | |
|---|---|
cpu |
有关 CPU 配置的信息。 |
gpu |
有关 GPU 配置的信息。 |
ram |
有关 RAM 配置的信息。 |
storage |
有关存储配置的信息。 |
SkuInstance
SKU 的特定实例。
| 字段 | |
|---|---|
region_code |
相应实例可用的 Unicode CLDR 区域代码。 |
power_supply |
相应实例的电源类型。 |
billing_sku |
Cloud Billing API 中相应 SKU 的引用。您可以使用该 API 检索估算价格信息。格式: |
billing_sku_per_vcpu |
Cloud Billing API 中每个 vCPU 的相应 SKU 的参考。您可以使用该 API 检索估算价格信息。格式: |
subscription_duration_months |
硬件的订阅时长(以月为单位)。 |
SubmitOrderRequest
提交订单的请求。
| 字段 | |
|---|---|
name |
必需。订单的名称。格式: |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
type |
可选。相应请求的类型。如果未设置,则假定请求类型为 |
类型
提交订单请求的有效类型。
| 枚举 | |
|---|---|
TYPE_UNSPECIFIED |
未指定请求类型。不应使用此值。 |
INFO_PENDING |
使用此请求类型提交订单并开始与 Google 对话。提交此表单后,您将无法修改所订购硬件的数量或 SKU。请注意,在您提供更多信息(例如区域网络配置、硬件物理和安装信息等)之前,此订单尚无法发货。如果您要提交 SKU 类型为 RACK 的订单,请使用此请求类型,因为 API 之外还需要提供其他信息。 |
INFO_COMPLETE |
如果您已准备好提交订单以进行配送,请使用此请求类型。除了 INFO_PENDING 所需的信息之外,订单还必须包含所有必需的信息,例如区域网络配置、硬件物理和安装信息等。之后将不再允许对任何订单信息进行更改。 |
子网
表示子网。
| 字段 | |
|---|---|
address_range |
必需。此子网的地址范围(采用 CIDR 表示法)。 |
default_gateway_ip_address |
必需。相应子网的默认网关。 |
SubscriptionConfig
用于存储订阅配置的消息。
| 字段 | |
|---|---|
subscription_id |
仅限输出。订阅的唯一标识符。 |
billing_id |
仅限输出。相应订阅所创建的 Google Cloud 结算 ID。 |
state |
仅限输出。订阅的当前状态。 |
SubscriptionState
用于表示订阅状态的枚举。
| 枚举 | |
|---|---|
SUBSCRIPTION_STATE_UNSPECIFIED |
状态未指定。 |
ACTIVE |
“有效”状态表示订阅已成功创建,并且正在结算。 |
INACTIVE |
“不活跃”表示订阅已成功创建,但结算尚未开始。 |
ERROR |
相应订阅处于错误状态。 |
FAILED_TO_RETRIEVE |
未能检索到订阅状态。这可能是暂时性问题。用户应重试请求。 |
COMPLETED |
订阅已完成,因为已达到结束日期。 |
TimePeriod
表示一周中的某个时间段。
| 字段 | |
|---|---|
start_time |
必需。时间段的开始时间。 |
end_time |
必需。时间段的结束时间。 |
days[] |
必需。相应时间段生效的星期。 |
UpdateHardwareGroupRequest
更新硬件组的请求。
| 字段 | |
|---|---|
update_mask |
必需。一个掩码,用于指定要通过此更新覆盖的 HardwareGroup 中的字段。update_mask 中指定的字段与硬件组相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果您未提供掩码,则所有字段都会被覆盖。 |
hardware_group |
必需。要更新的硬件组。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
UpdateHardwareRequest
更新硬件的请求。
| 字段 | |
|---|---|
update_mask |
必需。一个掩码,用于指定要通过此更新覆盖的硬件中的字段。updateMask 中指定的字段与硬件相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果您未提供掩码,则所有字段都会被覆盖。 |
hardware |
必需。要更新的硬件。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
UpdateOrderRequest
更新订单的请求。
| 字段 | |
|---|---|
update_mask |
必需。一个掩码,用于指定要通过此更新覆盖的订单中的字段。update_mask 中指定的字段与订单相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果您未提供掩码,则所有字段都会被覆盖。 |
order |
必需。要更新的订单。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
UpdateSiteRequest
更新网站的请求。
| 字段 | |
|---|---|
update_mask |
必需。一个掩码,用于指定要通过此更新覆盖的 Site 中的字段。update_mask 中指定的字段与网站相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果您未提供掩码,则所有字段都会被覆盖。 |
site |
必需。要更新的网站。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
UpdateZoneRequest
更新可用区的请求。
| 字段 | |
|---|---|
update_mask |
必需。一个掩码,用于指定要通过此更新覆盖的 Zone 中的字段。updateMask 中指定的字段与可用区相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。 如果您未提供掩码,则所有字段都会被覆盖。 |
zone |
必需。要更新的地区。 |
request_id |
可选。相应请求的可选唯一标识符。请参阅 AIP-155。 |
可用区
包含一组硬件的可用区。
| 字段 | |
|---|---|
name |
标识符。相应可用区的名称。格式: |
create_time |
仅限输出。相应可用区的创建时间。 |
update_time |
仅限输出。相应时区上次更新的时间。 |
labels |
可选。与相应可用区相关联的标签(以键值对的形式)。如需详细了解标签,请参阅创建和管理标签。 |
display_name |
可选。相应可用区的易记显示名称。 |
state |
仅限输出。相应可用区的当前状态。 |
contacts[] |
必需。联系人。 |
ciq_uri |
仅限输出。指向相应区域的客户信息收集问卷 (CIQ) 工作表的链接。 |
network_config |
可选。相应可用区的网络配置。 |
globally_unique_id |
仅限输出。为相应边缘区域生成的全局唯一标识符。 |
subscription_configs[] |
仅限输出。相应可用区的订阅配置。 |
provisioning_state |
仅限输出。配置(例如 MAC 地址)的配置状态。 |
ProvisioningState
适用于 MAC 地址等配置的有效配置状态。
| 枚举 | |
|---|---|
PROVISIONING_STATE_UNSPECIFIED |
配置状态未指定。 |
PROVISIONING_REQUIRED |
需要进行预配。由 Google 设置。 |
PROVISIONING_IN_PROGRESS |
正在进行配置。由客户设置。 |
PROVISIONING_COMPLETE |
配置已完成。由客户设置。 |
州
可用区的有效状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
未指定区域的状态。 |
ADDITIONAL_INFO_NEEDED |
需要客户提供更多信息才能继续处理。 |
PREPARING |
Google 正在准备该区域。 |
READY_FOR_CUSTOMER_FACTORY_TURNUP_CHECKS |
工厂启动已成功完成。 |
CUSTOMER_FACTORY_TURNUP_CHECKS_STARTED |
该区域正在运行出厂启动检查。 |
READY_FOR_SITE_TURNUP |
相应区域已准备好进行网站启动。 |
CUSTOMER_FACTORY_TURNUP_CHECKS_FAILED |
相应功能区在出厂启动检查中失败。 |
ACTIVE |
该可用区可供使用。 |
CANCELLED |
该 Zone 已取消。 |
ZoneNetworkConfig
相应可用区的网络配置。
| 字段 | |
|---|---|
machine_mgmt_ipv4_range |
必需。用于机器管理的 IPv4 地址块。应该是专用 RFC1918 或公共 CIDR 块,大小足以在相应可用区中为每台机器分配至少一个地址。应位于 |
kubernetes_node_ipv4_range |
必需。Kubernetes 节点的 IPv4 地址块。应该是专用 RFC1918 或公共 CIDR 块,大小足以在相应可用区中为每台机器分配至少一个地址。应位于 |
kubernetes_control_plane_ipv4_range |
必需。用于 Kubernetes 控制平面的 IPv4 地址块。应该是专用 RFC1918 或公共 CIDR 块,大小足以在相应可用区中为每个集群分配至少一个地址。应位于 |
management_ipv4_subnet |
必需。管理网络的 IPv4 子网。 |
kubernetes_ipv4_subnet |
可选。Kubernetes 网络的 IPv4 子网。如果未指定,则 Kubernetes 子网将与管理子网相同。 |
dns_ipv4_addresses[] |
可选。DNS 域名服务器。GDC 基础设施将通过这些 IP 解析 DNS 查询。如果未指定,则使用 Google DNS。 |
kubernetes_primary_vlan_id |
可选。Kubernetes VLAN ID。默认情况下,Kubernetes 节点(包括 Kubernetes 主网络)与机器管理网络位于同一 VLAN 中。为了实现网络分段,可以选择将它们分开。 |