Regions

Represents a Region resource. See the Regions & Zones documentation for more information.

For a list of methods for this resource, see the end of this page.

Resource representations

A Region resource.

{
  "kind": "compute#region",
  "selfLink": string,
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "status": string,
  "zones": [
    string
  ],
  "quotas": [
    {
      "metric": string,
      "limit": double,
      "usage": double
    }
  ],
  "deprecated": {
    "state": string,
    "replacement": string,
    "deprecated": string,
    "obsolete": string,
    "deleted": string
  }
}

Property name	Value	Description
`creationTimestamp`	`string`	[Output Only] Creation timestamp i n RFC3339 format .
`deprecated`	`nested object`	[Output Only] The deprecation status associated with this region.
`deprecated. deleted`	`string`	[Output Only] An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to `DELETED` .
`deprecated. deprecated`	`string`	An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to `DEPRECATED` .
`deprecated. obsolete`	`string`	[Output Only] An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to `OBSOLETE` .
`deprecated. replacement`	`string`	A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
`deprecated. state`	`string`	[Output Only] The deprecation state of this zone. Google Compute Engine sets this status if a region will be deprecated soon. Acceptable values are: " `DELETED` ": `DELETED` regions cannot be used by existing resources or new resources. You must choose another region to use. Google Compute Engine returns an error if you attempt to use this region and recommends an alternative region. " `DEPRECATED` ": `DEPRECATED` regions can still be used for new resource, but Google Compute Engine issues a warning and recommends a alternative zone. " `OBSOLETE` ": Existing resources already in an `OBSOLETE` region can continue to reside there so, but you cannot create new resources in this region. Google Compute Engine returns a warning if you attempt to use the region for a new resource and recommends an alternative region.
`description`	`string`	[Output Only] Textual description of the resource.
`id`	`unsigned long`	[Output Only] Unique identifier for the resource; defined by the server.
`kind`	`string`	[Output Only] Type of the resource. Always `compute#region.`
`name`	`string`	[Output Only] Name of the resource.
`quotas[]`	`list`	[Output Only] Quotas assigned to this region.
`quotas[]. limit`	`double`	[Output Only] Quota limit for this metric.
`quotas[]. metric`	`string`	[Output Only] Name of the quota metric. Acceptable values are: " `CPUS` ": Number of CPUs. " `DISKS` ": Number of persistent disks. " `DISKS_TOTAL_GB` ": Total aggregate size of persistent disks. " `EPHEMERAL_ADDRESSES` ": Number of ephemeral addresses. " `FIREWALLS` ": Number of firewalls. " `FORWARDING_RULES` ": Number of forwarding rules. " `HEALTH_CHECKS` ": Number of health checks. " `IMAGES` ": Number of custom images. " `IMAGES_TOTAL_GB` ": Total aggregate size of custom images. " `INSTANCES` ": Number of instances. " `IN_USE_ADDRESSES` ": Number of in-use addresses. " `KERNELS` ": Number of kernels. " `KERNELS_TOTAL_GB` ": Total aggregate size of kernels. " `NETWORKS` ": Number of networks. " `OPERATIONS` ": Number of operations. " `ROUTES` ": Number of routes. " `SNAPSHOTS` ": Number of persistent disk snapshots. " `STATIC_ADDRESSES` ": Number of reserved IP addresses. " `TARGET_INSTANCES` ": Number of target instances. " `TARGET_POOLS` ": Number of targetpools.
`quotas[]. usage`	`double`	[Output Only] Current usage of this metric.
`selfLink`	`string`	[Output Only] Server defined URL for the resource.
`status`	`string`	[Output Only] The status of the region, either `UP` or `DOWN` . Acceptable values are: " `DOWN` ": Specifies that the region is unavailable. " `UP` ": Specifies that the region is available.
`zones[]`	`list`	[Output Only] A list of zones in this region, in the form of resource URLs.

Methods

The following are valid Region resources:

get: Returns the specified region resource.
list: Retrieves the list of region resources available to the specified project.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License , and code samples are licensed under the Apache 2.0 License . For details, see our Site Policies .

Last updated December 3, 2013.

Google Compute Engine

Regions

Resource representations

Methods

Authentication required

Signing you in...