Compute Engine API . zones

Instance Methods

get(project, zone)

Returns the specified zone resource.

list(project, maxResults=None, pageToken=None, filter=None)

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

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, zone)
Returns the specified zone resource.

Args:
  project: string, Name of the project scoping this request. (required)
  zone: string, Name of the zone resource to return. (required)

Returns:
  An object of the form:

    {
    "status": "A String", # Status of the zone. "UP" or "DOWN".
    "kind": "compute#zone", # Type of the resource.
    "availableMachineType": [ # The machine types that can be used in this zone (output only).
      "A String",
    ],
    "description": "A String", # Textual description of the resource.
    "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
      {
        "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
        "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
        "name": "A String", # Name of the maintenance window.
        "description": "A String", # Textual description of the maintenance window.
      },
    ],
    "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    "selfLink": "A String", # Server defined URL for the resource (output only).
    "name": "A String", # Name of the resource.
  }
list(project, maxResults=None, pageToken=None, filter=None)
Retrieves the list of zone resources available to the specified project.

Args:
  project: string, Name of the project scoping this request. (required)
  maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
  pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
  filter: string, Optional. Filter expression for filtering listed resources.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
    "items": [ # The zone resources.
      {
        "status": "A String", # Status of the zone. "UP" or "DOWN".
        "kind": "compute#zone", # Type of the resource.
        "availableMachineType": [ # The machine types that can be used in this zone (output only).
          "A String",
        ],
        "description": "A String", # Textual description of the resource.
        "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
          {
            "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
            "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
            "name": "A String", # Name of the maintenance window.
            "description": "A String", # Textual description of the maintenance window.
          },
        ],
        "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "selfLink": "A String", # Server defined URL for the resource (output only).
        "name": "A String", # Name of the resource.
      },
    ],
    "kind": "compute#zoneList", # Type of resource.
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    "selfLink": "A String", # Server defined URL for this resource (output only).
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.