Contact UsGet started

Compute Cloud API, gRPC: ZoneService.List

Written by
Updated at November 26, 2024

Retrieves the list of availability zones.

gRPC request

rpc List (ListZonesRequest) returns (ListZonesResponse)

ListZonesRequest

{
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size,
the service returns a ListZonesResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

page_token

string

Page token. To get the next page of results, set page_token to the
ListZonesResponse.next_page_token returned by a previous list request.

ListZonesResponse

{
  "zones": [
    {
      "id": "string",
      "region_id": "string",
      "status": "Status"
    }
  ],
  "next_page_token": "string"
}

Field

Description

zones[]

Zone

List of availability zones.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListZonesRequest.page_size, use
the ListZonesRequest.page_token as the value
for the ListZonesRequest.page_token query parameter
in the next list request. Subsequent list requests will have their own
ListZonesRequest.page_token to continue paging through the results.

Zone

Availability zone. For more information, see Availability zones.

Field

Description

id

string

ID of the zone.

region_id

string

ID of the region.

status

enum Status

Status of the zone.

  • STATUS_UNSPECIFIED
  • UP: Zone is available. You can access the resources allocated in this zone.
  • DOWN: Zone is not available.
Previous
Get
Next
Overview