REST Resource: regions

Resource: Region

Represents a Region resource.

A region is a geographical area where a resource is located. For more information, read Regions and Zones.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "status": enum,
  "zones": [
    string
  ],
  "quotas": [
    {
      "metric": enum,
      "limit": number,
      "usage": number,
      "owner": string
    }
  ],
  "deprecated": {
    "state": enum,
    "replacement": string,
    "deprecated": string,
    "obsolete": string,
    "deleted": string,
    "stateOverride": {
      "locationRolloutPolicies": {
        string: string,
        ...
      },
      "defaultRolloutTime": string
    }
  },
  "selfLink": string,
  "supportsPzs": boolean,
  "kind": string
}
Fields
id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

name

string

[Output Only] Name of the resource.

description

string

[Output Only] Textual description of the resource.

status

enum

[Output Only] Status of the region, either UP or DOWN.

zones[]

string

[Output Only] A list of zones available in this region, in the form of resource URLs.

quotas[]

object

[Output Only] Quotas assigned to this region.

quotas[].metric

enum

[Output Only] Name of the quota metric.

quotas[].limit

number

[Output Only] Quota limit for this metric.

quotas[].usage

number

[Output Only] Current usage of this metric.

quotas[].owner

string

[Output Only] Owning resource. This is the resource on which this quota is applied.

deprecated

object

[Output Only] The deprecation status associated with this region.

deprecated.state

enum

The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. 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.

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.deprecated

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated.obsolete

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

deprecated.deleted

string

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated.stateOverride

object

The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state.

The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

deprecated.stateOverride.locationRolloutPolicies

map (key: string, value: string)

Location based rollout policies to apply to the resource.

Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

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

deprecated.stateOverride.defaultRolloutTime

string

An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

supportsPzs

boolean

[Output Only] Reserved for future use.

kind

string

[Output Only] Type of the resource. Always compute#region for regions.

Methods

get

Returns the specified Region resource.

list

Retrieves the list of region resources available to the specified project.