Compute Cloud API, REST: HostGroup.List
Retrieves the list of host groups in the specified folder.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/hostGroups
Query parameters
Field |
Description |
folderId |
string Required field. ID of the folder to list host groups in. |
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, |
filter |
string A filter expression that filters resources listed in the response. Each condition has the form
|
orderBy |
string By which column the listing should be ordered and in which direction, |
Response
HTTP Code: 200 - OK
{
"hostGroups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"zoneId": "string",
"status": "string",
"typeId": "string",
"maintenancePolicy": "string",
"scalePolicy": {
// Includes only one of the fields `fixedScale`
"fixedScale": {
"size": "string"
}
// end of the list of possible fields
}
}
],
"nextPageToken": "string"
}
Field |
Description |
hostGroups[] |
Lists host groups for the specified folder. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
HostGroup
Represents group of dedicated hosts
Field |
Description |
id |
string ID of the group. |
folderId |
string ID of the folder that the group belongs to. |
createdAt |
string (date-time) Creation timestamp in RFC3339 String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the group. The name is unique within the folder. |
description |
string Description of the group. |
labels |
string Resource labels as |
zoneId |
string Availability zone where all dedicated hosts are allocated. |
status |
enum (Status) Status of the group.
|
typeId |
string ID of host type. Resources provided by each host of the group. |
maintenancePolicy |
enum (MaintenancePolicy) Behaviour on maintenance events.
|
scalePolicy |
Scale policy. Only fixed number of hosts are supported at this moment. |
ScalePolicy
Field |
Description |
fixedScale |
Includes only one of the fields |
FixedScale
Field |
Description |
size |
string (int64) |