Compute Cloud API, gRPC: HostGroupService.ListHosts
Lists hosts that belongs to the specified host group.
gRPC request
rpc ListHosts (ListHostGroupHostsRequest) returns (ListHostGroupHostsResponse)
ListHostGroupHostsRequest
{
"host_group_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
host_group_id |
string Required field. ID of the host group to list hosts for. 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 The maximum value is 1000. |
|
page_token |
string Page token. To get the next page of results, The maximum string length in characters is 100. |
ListHostGroupHostsResponse
{
"hosts": [
{
"id": "string",
"status": "Status",
"server_id": "string",
"replacement": {
"host_id": "string",
"deadline_at": "google.protobuf.Timestamp"
}
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
hosts[] |
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 |
Host
Represents a dedicated host
|
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.
|
|
server_id |
string ID of the physical server that the host belongs to. |
|
replacement |
Set temporarily if maintenance is planned for this host, and a new host was provided as a replacement. |
Replacement
|
Field |
Description |
|
host_id |
string ID of the host which replaces this one. |
|
deadline_at |
The date and time when this host will be automatically freed of instances. |