REST Resource: projects.locations.zones

Resource: Zone

A zone holding a set of hardware.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "displayName": string,
  "state": enum (State),
  "contacts": [
    {
      object (Contact)
    }
  ],
  "ciqUri": string,
  "networkConfig": {
    object (ZoneNetworkConfig)
  },
  "globallyUniqueId": string,
  "subscriptionConfigs": [
    {
      object (SubscriptionConfig)
    }
  ],
  "provisioningState": enum (ProvisioningState)
}
Fields
name

string

Identifier. Name of this zone. Format: projects/{project}/locations/{location}/zones/{zone}
createTime

string (Timestamp format)

Output only. Time when this zone was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Time when this zone was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Optional. Labels associated with this zone as key value pairs. For more information about labels, see Create and manage labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
displayName

string

Optional. Human friendly display name of this zone.
state

enum (State)

Output only. Current state for this zone.
contacts[]

object (Contact)

Required. The points of contact.
ciqUri

string

Output only. Link to the Customer Intake Questionnaire (CIQ) sheet for this zone.
networkConfig

object (ZoneNetworkConfig)

Optional. Networking configuration for this zone.
globallyUniqueId

string

Output only. Globally unique identifier generated for this Edge Zone.
subscriptionConfigs[]

object (SubscriptionConfig)

Output only. Subscription configurations for this zone.
provisioningState

enum (ProvisioningState)

Output only. Provisioning state for configurations like MAC addresses.

State

Valid states for a zone.

Enums
STATE_UNSPECIFIED State of the Zone is unspecified.
ADDITIONAL_INFO_NEEDED More information is required from the customer to make progress.
PREPARING Google is preparing the Zone.
READY_FOR_CUSTOMER_FACTORY_TURNUP_CHECKS Factory turnup has succeeded.
READY_FOR_SITE_TURNUP The Zone is ready for site turnup.
CUSTOMER_FACTORY_TURNUP_CHECKS_FAILED The Zone failed in factory turnup checks.
ACTIVE The Zone is available to use.
CANCELLED The Zone has been cancelled.

ZoneNetworkConfig

Networking configuration for a zone.

JSON representation 
{
  "machineMgmtIpv4Range": string,
  "kubernetesNodeIpv4Range": string,
  "kubernetesControlPlaneIpv4Range": string,
  "managementIpv4Subnet": {
    object (Subnet)
  },
  "kubernetesIpv4Subnet": {
    object (Subnet)
  },
  "dnsIpv4Addresses": [
    string
  ],
  "kubernetesPrimaryVlanId": integer
}
Fields
machineMgmtIpv4Range

string

Required. An IPv4 address block for machine management. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per machine in the Zone. Should be in managementIpv4Subnet, and disjoint with other address ranges.
kubernetesNodeIpv4Range

string

Required. An IPv4 address block for kubernetes nodes. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per machine in the Zone. Should be in kubernetesIpv4Subnet, and disjoint with other address ranges.
kubernetesControlPlaneIpv4Range

string

Required. An IPv4 address block for kubernetes control plane. Should be a private RFC1918 or public CIDR block large enough to allocate at least one address per cluster in the Zone. Should be in kubernetesIpv4Subnet, and disjoint with other address ranges.
managementIpv4Subnet

object (Subnet)

Required. An IPv4 subnet for the management network.
kubernetesIpv4Subnet

object (Subnet)

Optional. An IPv4 subnet for the kubernetes network. If unspecified, the kubernetes subnet will be the same as the management subnet.
dnsIpv4Addresses[]

string

Optional. DNS nameservers. The GDC Infrastructure will resolve DNS queries via these IPs. If unspecified, Google DNS is used.
kubernetesPrimaryVlanId

integer

Optional. Kubernetes VLAN ID. By default, the kubernetes node, including the primary kubernetes network, are in the same VLAN as the machine management network. For network segmentation purposes, these can optionally be separated.

Subnet

Represents a subnet.

JSON representation 
{
  "addressRange": string,
  "defaultGatewayIpAddress": string
}
Fields
addressRange

string

Required. Address range for this subnet in CIDR notation.
defaultGatewayIpAddress

string

Required. Default gateway for this subnet.

SubscriptionConfig

A message to store a subscription configuration.

JSON representation 
{
  "subscriptionId": string,
  "billingId": string,
  "state": enum (SubscriptionState)
}
Fields
subscriptionId

string

Output only. The unique identifier of the subscription.
billingId

string

Output only. The Google Cloud Billing ID that the subscription is created under.
state

enum (SubscriptionState)

Output only. The current state of the subscription.

SubscriptionState

Enum to represent the state of the subscription.

Enums
SUBSCRIPTION_STATE_UNSPECIFIED State is unspecified.
ACTIVE Active state means that the subscription has been created successfully and billing is happening.
INACTIVE Inactive means that the subscription has been created successfully, but billing has not started yet.
ERROR The subscription is in an erroneous state.
FAILED_TO_RETRIEVE The subscription state failed to be retrieved. This may be a transient issue. The user should retry the request.
COMPLETED The subscription has been completed, because it has reached the end date.

ProvisioningState

Valid provisioning states for configurations like MAC addresses.

Enums
PROVISIONING_STATE_UNSPECIFIED Provisioning state is unspecified.
PROVISIONING_REQUIRED Provisioning is required. Set by Google.
PROVISIONING_IN_PROGRESS Provisioning is in progress. Set by customer.
PROVISIONING_COMPLETE Provisioning is complete. Set by customer.

Methods

create

 Creates a new zone in a given project and location.

delete

 Deletes a zone.

get

 Gets details of a zone.

list

 Lists zones in a given project and location.

patch

 Updates the parameters of a zone.

signal

 Signals the state of a zone.