Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Compute Cloud API, REST: HostGroup.Create

Written by
Updated at October 17, 2024

Creates a host group in the specified folder.

HTTP request

POST https://compute.api.cloud.yandex.net/compute/v1/hostGroups

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "zoneId": "string",
  "typeId": "string",
  "maintenancePolicy": "string",
  "scalePolicy": {
    // Includes only one of the fields `fixedScale`
    "fixedScale": {
      "size": "string"
    }
    // end of the list of possible fields
  }
}

Field

Description

folderId

string

Required field. ID of the folder to create a host group in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

name

string

Name of the group.

description

string

Description of the group.

labels

string

Resource labels as key:value pairs.

zoneId

string

Required field. Availability zone where all dedicated hosts will be allocated.

typeId

string

Required field. ID of host type. Resources provided by each host of the group.

maintenancePolicy

enum (MaintenancePolicy)

Behaviour on maintenance events.

  • MAINTENANCE_POLICY_UNSPECIFIED
  • RESTART: Restart instance to move it to another host during maintenance
  • MIGRATE: Use live migration to move instance to another host during maintenance

scalePolicy

ScalePolicy

Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field

Description

fixedScale

FixedScale

Includes only one of the fields fixedScale.

FixedScale

Field

Description

size

string (int64)

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "hostGroupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "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
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateHostGroupMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

HostGroup

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateHostGroupMetadata

Field

Description

hostGroupId

string

ID of the host group that is being created.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

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 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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

string

Resource labels as key:value pairs.

zoneId

string

Availability zone where all dedicated hosts are allocated.

status

enum (Status)

Status of the group.

  • STATUS_UNSPECIFIED
  • CREATING
  • READY
  • UPDATING
  • DELETING

typeId

string

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

maintenancePolicy

enum (MaintenancePolicy)

Behaviour on maintenance events.

  • MAINTENANCE_POLICY_UNSPECIFIED
  • RESTART: Restart instance to move it to another host during maintenance
  • MIGRATE: Use live migration to move instance to another host during maintenance

scalePolicy

ScalePolicy

Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field

Description

fixedScale

FixedScale

Includes only one of the fields fixedScale.

FixedScale

Field

Description

size

string (int64)
Previous
List
Next
Update