Contact UsGet started

Compute Cloud API, gRPC: PlacementGroupService.Create

Written by
Updated at October 17, 2024

Creates a placement group in the specified folder.

gRPC request

rpc Create (CreatePlacementGroupRequest) returns (operation.Operation)

CreatePlacementGroupRequest

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  // Includes only one of the fields `spreadPlacementStrategy`, `partitionPlacementStrategy`
  "spreadPlacementStrategy": "SpreadPlacementStrategy",
  "partitionPlacementStrategy": {
    "partitions": "int64"
  }
  // end of the list of possible fields
}

Field

Description

folderId

string

ID of the folder to create a placement group in.

To get a folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

name

string

Name of the placement group.

description

string

Description of the placement group.

labels

string

Resource labels as key:value pairs.

spreadPlacementStrategy

SpreadPlacementStrategy

Anti-affinity placement strategy (spread). Instances are distributed over distinct failure domains.

Includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy.

Placement strategy.

partitionPlacementStrategy

PartitionPlacementStrategy

Includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy.

Placement strategy.

SpreadPlacementStrategy

This is an empty structure that must be passed to explicitly
specify the required placement strategy.

Field

Description

Empty

PartitionPlacementStrategy

Field

Description

partitions

int64

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "placementGroupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "string",
    // Includes only one of the fields `spreadPlacementStrategy`, `partitionPlacementStrategy`
    "spreadPlacementStrategy": "SpreadPlacementStrategy",
    "partitionPlacementStrategy": {
      "partitions": "int64"
    }
    // 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

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

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

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

CreatePlacementGroupMetadata

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

google.rpc.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

PlacementGroup

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.

CreatePlacementGroupMetadata

Field

Description

placementGroupId

string

ID of the placement group that is being created.

PlacementGroup

Field

Description

id

string

ID of the placement group. Generated at creation time.

folderId

string

ID of the folder that the placement group belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the placement group.
The name is unique within the folder.

description

string

Description of the placement group. 0-256 characters long.

labels

string

Placement group labels as key:value pairs.

spreadPlacementStrategy

SpreadPlacementStrategy

Anti-affinity placement strategy (spread). Instances are distributed
over distinct failure domains.

Includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy.

Placement strategy. To specify a placement strategy, send the corresponding
field containing approriate structure.

partitionPlacementStrategy

PartitionPlacementStrategy

Includes only one of the fields spreadPlacementStrategy, partitionPlacementStrategy.

Placement strategy. To specify a placement strategy, send the corresponding
field containing approriate structure.

SpreadPlacementStrategy

This is an empty structure that must be passed to explicitly
specify the required placement strategy.

Field

Description

Empty

PartitionPlacementStrategy

Field

Description

partitions

int64
Previous
List
Next
Update