Google Cloud Platform
Hide
Google Compute Engine
Write Feedback

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 Notes
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
deprecated nested object [Output Only] The deprecation status associated with this region.
deprecated.deleted string 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 An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
deprecated.replacement string The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
deprecated.state string The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
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 for regions.
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.
quotas[].usage double [Output Only] Current usage of this metric.
status string [Output Only] Status of the region, either UP or DOWN.
zones[] list [Output Only] A list of zones available 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.