REST Resource: regions

Resource: Region

Represents a Region resource.

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

JSON representation
{"kind":string,"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,"quotaStatusWarning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}
Fields
kind

string

Output only. Type of the resource. Alwayscompute#region for regions.

id

string (uint64 format)

Output only. The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

Output only. Creation timestamp inRFC3339 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, eitherUP orDOWN.

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 beACTIVE,DEPRECATED,OBSOLETE, orDELETED. Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which useOBSOLETE orDELETED 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 optionalRFC3339 timestamp on or after which the state of this resource is intended to change toDEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated.obsolete

string

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

deprecated.deleted

string

An optionalRFC3339 timestamp on or after which the state of this resource is intended to change toDELETED. 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 theimageFamilyViews.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 anRFC3339 timestamp on or after which the update is considered rolled out to the specified location.

deprecated.stateOverride.defaultRolloutTime

string

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

selfLink

string

Output only. Server-defined URL for the resource.

supportsPzs

boolean

Output only. Reserved for future use.

quotaStatusWarning

object

Output only. Warning of fetching thequotas field for this region. This field is populated only if fetching of thequotas field fails.

quotaStatusWarning.code

enum

Output only. A warning code, if applicable. For example, Compute Engine returnsNO_RESULTS_ON_PAGE if there are no results in the response.

quotaStatusWarning.message

string

Output only. A human-readable description of the warning code.

quotaStatusWarning.data[]

object

Output only. Metadata about this warning inkey: value format. For example:

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }

quotaStatusWarning.data[].key

string

Output only. A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might bescope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

quotaStatusWarning.data[].value

string

Output only. A warning data value corresponding to the key.

Methods

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 theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-10 UTC.