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)
  }
}
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.

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.
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)
  }
}
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.

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.

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.