External DocumentationTo learn more, visit the GCP documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Filter | A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: AND expression. However, you can include AND and OR expressions explicitly. For example: |
| Project | Project ID for this request. |
| Return All Pages | Automatically fetch all resources, page by page. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Max Results | The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500). |
| Order By | 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 orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. |
| Return Partial Success | Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
Example Output
{
"kind": "compute#zoneList",
"id": "projects/1234567/zones",
"items": [
{
"kind": "compute#zone",
"id": "2231",
"creationTimestamp": "1969-12-31T16:00:00.000-08:00",
"name": "us-east1-b",
"description": "us-east1-b",
"status": "UP",
"region": "https://www.googleapis.com/compute/v1/projects/example-12345/regions/us-east1",
"selfLink": "https://www.googleapis.com/compute/v1/projects/example-12345/zones/us-east1-b",
"availableCpuPlatforms": [
"Intel Ice Lake",
"Intel Cascade Lake",
"Intel Skylake",
"Intel Broadwell",
"Intel Haswell",
"Intel Ivy Bridge",
"Intel Sandy Bridge",
"AMD Milan",
"AMD Rome"
],
"supportsPzs": false
},
{
"kind": "compute#zone",
"id": "2233",
"creationTimestamp": "1969-12-31T16:00:00.000-08:00",
"name": "us-east1-c",
"description": "us-east1-c",
"status": "UP",
"region": "https://www.googleapis.com/compute/v1/projects/example-12345/regions/us-east1",
"selfLink": "https://www.googleapis.com/compute/v1/projects/example-12345/zones/us-east1-c",
"availableCpuPlatforms": [
"Intel Ice Lake",
"Intel Cascade Lake",
"Intel Skylake",
"Intel Broadwell",
"Intel Haswell",
"Intel Ivy Bridge",
"Intel Sandy Bridge",
"AMD Milan",
"AMD Rome"
],
"supportsPzs": false
}
],
"selfLink": "https://www.googleapis.com/compute/v1/projects/123456/zones"
}