- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Returns the specified Region resource. Gets a list of available regions by making a list()
request.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
resourceId |
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 | |
---|---|
{ "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, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
[Output Only] Name of the resource. |
description |
[Output Only] Textual description of the resource. |
status |
[Output Only] Status of the region, either |
zones[] |
[Output Only] A list of zones available in this region, in the form of resource URLs. |
quotas[] |
[Output Only] Quotas assigned to this region. |
quotas[].metric |
[Output Only] Name of the quota metric. |
quotas[].limit |
[Output Only] Quota limit for this metric. |
quotas[].usage |
[Output Only] Current usage of this metric. |
quotas[].owner |
[Output Only] Owning resource. This is the resource on which this quota is applied. |
deprecated |
[Output Only] The deprecation status associated with this region. |
deprecated.state |
The deprecation state of this resource. This can be |
deprecated.replacement |
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 |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
deprecated.obsolete |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
deprecated.deleted |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
selfLink |
[Output Only] Server-defined URL for the resource. |
kind |
[Output Only] Type of the resource. Always |
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 Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.regions.get