Method listHosts
Written by
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
| Parameter | Description |
|---|---|
| hostGroupId | Required. ID of the host group to list hosts for. To get the host group ID, use list request. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
| pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"hosts": [
{
"id": "string",
"status": "string",
"serverId": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| hosts[] | object Represents a dedicated host |
| hosts[]. id |
string ID of the host. |
| hosts[]. status |
string Current status of the host. New instances are unable to start on host in DOWN status. |
| hosts[]. serverId |
string ID of the physical server that the host belongs to. |
| nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is more than pageSize, use nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |