Contact UsGet started

Compute Cloud API, REST: Zone.List

Written by
Updated at November 26, 2024

Retrieves the list of availability zones.

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/zones

Query parameters

Field

Description

pageSize

string (int64)

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

pageToken

string

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

Response

HTTP Code: 200 - OK

{
  "zones": [
    {
      "id": "string",
      "regionId": "string",
      "status": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

zones[]

Zone

List of availability zones.

nextPageToken

string

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

Zone

Availability zone. For more information, see Availability zones.

Field

Description

id

string

ID of the zone.

regionId

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