Method 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
| Parameter | Description |
|---|---|
| folderId | Required. ID of the folder to list host groups in. To get the folder ID, use list request. The maximum string length in characters is 50. |
| 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. |
| filter | A filter expression that filters resources listed in the response. Currently you can use filtering only on the HostGroup.name field. The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"hostGroups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"zoneId": "string",
"status": "string",
"typeId": "string",
"maintenancePolicy": "string",
"scalePolicy": {
"fixedScale": {
"size": "string"
}
}
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| hostGroups[] | object Lists host groups for the specified folder. |
| hostGroups[]. id |
string ID of the group. |
| hostGroups[]. folderId |
string ID of the folder that the group belongs to. |
| hostGroups[]. createdAt |
string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. |
| hostGroups[]. name |
string Name of the group. The name is unique within the folder. |
| hostGroups[]. description |
string Description of the group. |
| hostGroups[]. labels |
object Resource labels as |
| hostGroups[]. zoneId |
string Availability zone where all dedicated hosts are allocated. |
| hostGroups[]. status |
string Status of the group. |
| hostGroups[]. typeId |
string ID of host type. Resources provided by each host of the group. |
| hostGroups[]. maintenancePolicy |
string Behaviour on maintenance events.
|
| hostGroups[]. scalePolicy |
object Scale policy. Only fixed number of hosts are supported at this moment. |
| hostGroups[]. scalePolicy. fixedScale |
object |
| hostGroups[]. scalePolicy. fixedScale. size |
string (int64) |
| nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger 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. |