Method: zones.list

Retrieves the list of Zone resources available to the specified project.

HTTP request

GET https://www.googleapis.com/compute/v1/projects/{project}/zones

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

number (uint32 format)

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)

pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

filter

string

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, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

orderBy

string

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.

Request body

The request body must be empty.

Response body

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

Contains a list of zone resources.

JSON representation
{
  "id": string,
  "items": [
    {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "status": enum,
      "deprecated": {
        "state": enum,
        "replacement": string,
        "deprecated": string,
        "obsolete": string,
        "deleted": string
      },
      "region": string,
      "selfLink": string,
      "availableCpuPlatforms": string,
      "kind": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": {
      "key": string,
      "value": string
    }
  },
  "kind": string
}
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object

A list of Zone resources.

items[].id

string (fixed64 format)

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

items[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

items[].name

string

[Output Only] Name of the resource.

items[].description

string

[Output Only] Textual description of the resource.

items[].status

enum

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

items[].deprecated

object

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

items[].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.

items[].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.

items[].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.

items[].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.

items[].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.

items[].region

string

[Output Only] Full URL reference to the region which hosts the zone.

items[].selfLink

string

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

items[].availableCpuPlatforms[]

string

[Output Only] Available cpu/platform selections for the zone. Do not use field = 7 or field = 11. Next available field = 14.

items[].kind

string

[Output Only] Type of the resource. Always compute#zone for zones.

nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

warning

object

[Output Only] Informational warning message.

warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

warning.message

string

[Output Only] A human-readable description of the warning code.

warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example:

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }

warning.data[].key

string

[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

warning.data[].value

string

[Output Only] A warning data value corresponding to the key.

kind

string

Type of resource.

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 Google IAM permissions:

  • compute.zones.list
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...