Compute Cloud API, gRPC: HostGroupService.ListHosts

Field

Description

host_group_id

string

Required field. ID of the host group to list hosts for.
To get the host group ID, use HostGroupService.List request.

The maximum string length in characters is 50.

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 ListHostGroupHostsResponse.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 ListHostGroupHostsResponse.next_page_token
returned by a previous list request.

The maximum string length in characters is 100.

Field

Description

hosts[]

Host

Lists hosts for the specified host group.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is more than ListHostGroupHostsRequest.page_size, use
next_page_token as the value
for the ListHostGroupHostsRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

Field

Description

id

string

ID of the host.

status

enum Status

Current status of the host. New instances are unable to start on host in DOWN status.

• UP
• DOWN

server_id

string

ID of the physical server that the host belongs to.

replacement

Replacement

Set temporarily if maintenance is planned for this host, and a new host was provided as a replacement.

Field

Description

host_id

string

ID of the host which replaces this one.

deadline_at

google.protobuf.Timestamp

The date and time when this host will be automatically freed of instances.