Method: regions.get

Returns the specified Region resource.

To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (thequotas field). To exclude one or more fields, set your request'sfields query parameter to only include the fields you need. For example, to only include theid andselfLink fields, add the query parameter?fields=id,selfLink to your request.

This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (theitems.quotas field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}

The URL usesgRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to theservice error catalog

Path parameters

Parameters
project

string

Project ID for this request.

region

string

Name of the region resource to return.

Request body

The request body must be empty.

Response body

Represents a Region resource.

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

If successful, the response body contains data with the following structure:

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},"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.

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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the followingIAM permissions:

  • compute.regions.get

To find predefined roles that contain those permissions, seeCompute Engine IAM Roles.

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 2025-09-18 UTC.