Compute Cloud API, REST: HostGroup.ListHosts
Lists hosts that belongs to the specified host group.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/hostGroups/{hostGroupId}/hosts
Path parameters
Field |
Description |
hostGroupId |
string Required field. ID of the host group to list hosts for. |
Query parameters
Field |
Description |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, |
Response
HTTP Code: 200 - OK
{
"hosts": [
{
"id": "string",
"status": "string",
"serverId": "string",
"replacement": {
"hostId": "string",
"deadlineAt": "string"
}
}
],
"nextPageToken": "string"
}
Field |
Description |
hosts[] |
Lists hosts for the specified host group. |
nextPageToken |
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.
|
serverId |
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 |
hostId |
string ID of the host which replaces this one. |
deadlineAt |
string (date-time) The date and time when this host will be automatically freed of instances. String in RFC3339 To work with values in this field, use the APIs described in the |