- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves the list of Zone resources under the specific region available to the specified project.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/zones
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project
|
Project ID for this request. |
region
|
Region for this request. |
Query parameters
Parameters | |
---|---|
maxResults
|
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken
|
Specifies a page token to use. Set |
filter
|
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160 . These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy
|
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
returnPartialSuccess
|
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
Request body
The request body must be empty.
Response body
Contains a list of zone resources.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind" : string , "id" : string , "items" : [ { "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 } ] , "nextPageToken" : string , "selfLink" : string , "warning" : { "code" : enum , "message" : string , "data" : [ { "key" : string , "value" : string } ] } } |
Fields | |
---|---|
kind
|
Type of resource. |
id
|
[Output Only] Unique identifier for the resource; defined by the server. |
items[]
|
A list of Zone resources. |
items[].kind
|
[Output Only] Type of the resource. Always |
items[].id
|
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp
|
[Output Only] Creation timestamp in RFC3339 text format. |
items[].name
|
[Output Only] Name of the resource. |
items[].description
|
[Output Only] Textual description of the resource. |
items[].status
|
[Output Only] Status of the zone, either |
items[].deprecated
|
[Output Only] The deprecation status associated with this zone. |
items[].deprecated.state
|
The deprecation state of this resource. This can be |
items[].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. |
items[].deprecated.deprecated
|
An optional RFC3339
timestamp on or after which the state of this resource is intended to change to |
items[].deprecated.obsolete
|
An optional RFC3339
timestamp on or after which the state of this resource is intended to change to |
items[].deprecated.deleted
|
An optional RFC3339
timestamp on or after which the state of this resource is intended to change to |
items[].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 |
items[].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. |
items[].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. |
items[].region
|
[Output Only] Full URL reference to the region which hosts the zone. |
items[].selfLink
|
[Output Only] Server-defined URL for the resource. |
items[].availableCpuPlatforms[]
|
[Output Only] Available cpu/platform selections for the zone. |
items[].supportsPzs
|
[Output Only] Reserved for future use. |
nextPageToken
|
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink
|
[Output Only] Server-defined URL for this resource. |
warning
|
[Output Only] Informational warning message. |
warning.code
|
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message
|
[Output Only] A human-readable description of the warning code. |
warning.data[]
|
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key
|
[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 be |
warning.data[].value
|
[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 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.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .