Get started
Yandex Compute Cloud

HostGroup

A set of methods for managing groups of dedicated hosts.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "zoneId": "string",
  "status": "string",
  "typeId": "string",
  "maintenancePolicy": "string",
  "scalePolicy": {
    "fixedScale": {
      "size": "string"
    }
  }
}
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 text format.

String in RFC3339 text format.
name string

Name of the group. The name is unique within the folder.
description string

Description of the group.
labels object

Resource labels as key:value pairs.
zoneId string

Availability zone where all dedicated hosts are allocated.
status string

Status of the group.
typeId string

ID of host type. Resources provided by each host of the group.
maintenancePolicy string

Behaviour on maintenance events.

  • RESTART: Restart instances on the same host after maintenance event.
  • MIGRATE: Migrate instances to another host before maintenance event.
scalePolicy object

Scale policy. Only fixed number of hosts are supported at this moment.
scalePolicy.
fixedScale		 object
scalePolicy.
fixedScale.
size		 string (int64)

Methods

Method Description
create Creates a host group in the specified folder.
delete Deletes the specified host group.
get Returns the specified host group.
list Retrieves the list of host groups in the specified folder.
listHosts Lists hosts that belongs to the specified host group.
listInstances Lists instances that belongs to the specified host group.
listOperations Lists operations for the specified host group.
update Updates the specified host group.
In this article: