- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Returns the specified Zone resource.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
Name of the zone resource to return. |
Request body
The request body must be empty.
Response body
Represents a Zone resource.
A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-b
is located in the us-east1
region. For more information, read Regions 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, "deprecated": { "state": enum, "replacement": string, "deprecated": string, "obsolete": string, "deleted": string, "stateOverride": { "locationRolloutPolicies": { string: string, ... }, "defaultRolloutTime": string } }, "region": string, "selfLink": string, "availableCpuPlatforms": [ string ], "supportsPzs": boolean } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
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 zone, either |
deprecated |
[Output Only] The deprecation status associated with this zone. |
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 |
deprecated.stateOverride |
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 |
deprecated.stateOverride.locationRolloutPolicies |
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. |
deprecated.stateOverride.defaultRolloutTime |
An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated. |
region |
[Output Only] Full URL reference to the region which hosts the zone. |
selfLink |
[Output Only] Server-defined URL for the resource. |
availableCpuPlatforms[] |
[Output Only] Available cpu/platform selections for the zone. |
supportsPzs |
[Output Only] Reserved for future use. |
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 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.zones.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.