Method: regions.get

Returns the specified Region resource. Gets a list of available regions by making a list() request.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/regions/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

resourceId

string

Name of the region resource to return.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "resource": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "status": enum,
    "zones": string,
    "quotas": {
      "metric": enum,
      "limit": number,
      "usage": number
    },
    "deprecated": {
      "state": enum,
      "replacement": string,
      "deprecated": string,
      "obsolete": string,
      "deleted": string
    },
    "selfLink": string,
    "kind": string
  }
}
Fields
resource

object

resource.id

string (fixed64 format)

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

resource.creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

resource.name

string

[Output Only] Name of the resource.

resource.description

string

[Output Only] Textual description of the resource.

resource.status

enum

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

resource.zones[]

string

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

resource.quotas[]

object

[Output Only] Quotas assigned to this region.

resource.quotas[].metric

enum

[Output Only] Name of the quota metric.

resource.quotas[].limit

number

[Output Only] Quota limit for this metric.

resource.quotas[].usage

number

[Output Only] Current usage of this metric.

resource.deprecated

object

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

resource.deprecated.state

enum

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.

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

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.

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

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

resource.selfLink

string

[Output Only] Server-defined URL for the resource.

resource.kind

string

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

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

IAM Permissions

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

  • compute.regions.get

Send feedback about...

Compute Engine