Compute Cloud API, REST: HostGroup.get
Returns the specified host group.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/hostGroups/{hostGroupId}
Path parameters
Parameter | Description |
---|---|
hostGroupId | Required. ID of the host group to return. To get the host group ID, use list request. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"zoneId": "string",
"status": "string",
"typeId": "string",
"maintenancePolicy": "string",
"scalePolicy": {
"fixedScale": {
"size": "string"
}
}
}
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 text format. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the group. The name is unique within the folder. |
description | string Description of the group. |
labels | object Resource labels as |
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.
|
scalePolicy | object Scale policy. Only fixed number of hosts are supported at this moment. |
scalePolicy. fixedScale |
object |
scalePolicy. fixedScale. size |
string (int64) |