Compute Cloud API, gRPC: ZoneService
Written by
Updated at December 13, 2022
A set of methods to retrieve information about availability zones.
| Call | Description |
|---|---|
| Get | Returns the information about the specified availability zone. |
| List | Retrieves the list of availability zones. |
Calls ZoneService
Get
Returns the information about the specified availability zone.
To get the list of availability zones, make a List request.
rpc Get (GetZoneRequest) returns (Zone)
GetZoneRequest
| Field | Description |
|---|---|
| zone_id | string Required. ID of the availability zone to return information about. The maximum string length in characters is 50. |
Zone
| Field | Description |
|---|---|
| id | string ID of the zone. |
| region_id | string ID of the region. |
| status | enum Status Status of the zone.
|
List
Retrieves the list of availability zones.
rpc List (ListZonesRequest) returns (ListZonesResponse)
ListZonesRequest
| 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. The maximum value is 1000. |
| 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. The maximum string length in characters is 100. |
ListZonesResponse
| 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
| Field | Description |
|---|---|
| id | string ID of the zone. |
| region_id | string ID of the region. |
| status | enum Status Status of the zone.
|