Compute Cloud API, gRPC: HostGroupService.Get
Returns the specified host group.
gRPC request
rpc Get (GetHostGroupRequest) returns (HostGroup)
GetHostGroupRequest
{
"hostGroupId": "string"
}
|
Field |
Description |
|
hostGroupId |
string Required field. ID of the host group to return. |
HostGroup
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"zoneId": "string",
"status": "Status",
"typeId": "string",
"maintenancePolicy": "MaintenancePolicy",
"scalePolicy": {
// Includes only one of the fields `fixedScale`
"fixedScale": {
"size": "int64"
}
// end of the list of possible fields
}
}
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 |
Creation timestamp in RFC3339 text format. |
|
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 |
int64 |