Compute Cloud API, gRPC: PlacementGroupService
A set of methods for managing placement groups.
Call | Description |
---|---|
Get | Returns the specified placement group. |
List | Retrieves the list of placement groups in the specified folder. |
Create | Creates a placement group in the specified folder. |
Update | Updates the specified placement group. |
Delete | Deletes the specified placement group. |
ListInstances | Lists instances for the specified placement group. |
ListOperations | Lists operations for the specified placement group. |
Calls PlacementGroupService
Get
Returns the specified placement group.
To get the list of all available placement groups, make a List request.
rpc Get (GetPlacementGroupRequest) returns (PlacementGroup)
GetPlacementGroupRequest
Field | Description |
---|---|
placement_group_id | string ID of the placement group to return. To get a placement group ID make a PlacementGroupService.List request. |
PlacementGroup
Field | Description |
---|---|
id | string ID of the placement group. Generated at creation time. |
folder_id | string ID of the folder that the placement group belongs to. |
created_at | 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 | map<string,string> Placement group labels as key:value pairs. |
placement_strategy | oneof: spread_placement_strategy or partition_placement_strategy Placement strategy. To specify a placement strategy, send the corresponding field containing approriate structure. |
spread_placement_strategy | SpreadPlacementStrategy Anti-affinity placement strategy ( spread ). Instances are distributed over distinct failure domains. |
partition_placement_strategy | PartitionPlacementStrategy Placement strategy. To specify a placement strategy, send the corresponding field containing approriate structure. |
SpreadPlacementStrategy
Empty
PartitionPlacementStrategy
Field | Description |
---|---|
partitions | int64 Acceptable values are 2 to 5, inclusive. |
List
Retrieves the list of placement groups in the specified folder.
rpc List (ListPlacementGroupsRequest) returns (ListPlacementGroupsResponse)
ListPlacementGroupsRequest
Field | Description |
---|---|
folder_id | string ID of the folder to list placement groups in. To get the folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListPlacementGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. |
page_token | string Page token. To get the next page of results, set page_token to the ListPlacementGroupsResponse.next_page_token returned by a previous list request. |
filter | string A filter expression that filters resources listed in the response. Currently you can use filtering only on the PlacementGroup.name field. |
ListPlacementGroupsResponse
Field | Description |
---|---|
placement_groups[] | PlacementGroup Lists placement groups in the specified folder. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListPlacementGroupsRequest.page_size, use next_page_token as the value for the ListPlacementGroupsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
PlacementGroup
Field | Description |
---|---|
id | string ID of the placement group. Generated at creation time. |
folder_id | string ID of the folder that the placement group belongs to. |
created_at | 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 | map<string,string> Placement group labels as key:value pairs. |
placement_strategy | oneof: spread_placement_strategy or partition_placement_strategy Placement strategy. To specify a placement strategy, send the corresponding field containing approriate structure. |
spread_placement_strategy | SpreadPlacementStrategy Anti-affinity placement strategy ( spread ). Instances are distributed over distinct failure domains. |
partition_placement_strategy | PartitionPlacementStrategy Placement strategy. To specify a placement strategy, send the corresponding field containing approriate structure. |
SpreadPlacementStrategy
Empty
PartitionPlacementStrategy
Field | Description |
---|---|
partitions | int64 Acceptable values are 2 to 5, inclusive. |
Create
Creates a placement group in the specified folder.
rpc Create (CreatePlacementGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreatePlacementGroupMetadata
Operation.response:PlacementGroup
CreatePlacementGroupRequest
Field | Description |
---|---|
folder_id | 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 | map<string,string> Resource labels as key:value pairs. |
placement_strategy | oneof: spread_placement_strategy Placement strategy. |
spread_placement_strategy | SpreadPlacementStrategy Anti-affinity placement strategy ( spread ). Instances are distributed over distinct failure domains. |
SpreadPlacementStrategy
Empty
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any<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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<PlacementGroup> if operation finished successfully. |
CreatePlacementGroupMetadata
Field | Description |
---|---|
placement_group_id | string ID of the placement group that is being created. |
PlacementGroup
Field | Description |
---|---|
id | string ID of the placement group. Generated at creation time. |
folder_id | string ID of the folder that the placement group belongs to. |
created_at | 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 | map<string,string> Placement group labels as key:value pairs. |
placement_strategy | oneof: spread_placement_strategy or partition_placement_strategy Placement strategy. To specify a placement strategy, send the corresponding field containing approriate structure. |
spread_placement_strategy | SpreadPlacementStrategy Anti-affinity placement strategy ( spread ). Instances are distributed over distinct failure domains. |
partition_placement_strategy | PartitionPlacementStrategy Placement strategy. To specify a placement strategy, send the corresponding field containing approriate structure. |
PartitionPlacementStrategy
Field | Description |
---|---|
partitions | int64 Acceptable values are 2 to 5, inclusive. |
Update
Updates the specified placement group.
rpc Update (UpdatePlacementGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdatePlacementGroupMetadata
Operation.response:PlacementGroup
UpdatePlacementGroupRequest
Field | Description |
---|---|
placement_group_id | string ID of the placement group to update. To get the placement group ID, use an PlacementGroupService.List request. |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the PlacementGroup resource should be updated. |
name | string Name of the placement group. |
description | string Description of the placement group. |
labels | map<string,string> Resource labels as key:value pairs. The existing set of labels is completely replaced by the provided set. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any<UpdatePlacementGroupMetadata> 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<PlacementGroup> if operation finished successfully. |
UpdatePlacementGroupMetadata
Field | Description |
---|---|
placement_group_id | string ID of the placement group that is being updated. |
PlacementGroup
Field | Description |
---|---|
id | string ID of the placement group. Generated at creation time. |
folder_id | string ID of the folder that the placement group belongs to. |
created_at | 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 | map<string,string> Placement group labels as key:value pairs. |
placement_strategy | oneof: spread_placement_strategy or partition_placement_strategy Placement strategy. To specify a placement strategy, send the corresponding field containing approriate structure. |
spread_placement_strategy | SpreadPlacementStrategy Anti-affinity placement strategy ( spread ). Instances are distributed over distinct failure domains. |
partition_placement_strategy | PartitionPlacementStrategy Placement strategy. To specify a placement strategy, send the corresponding field containing approriate structure. |
SpreadPlacementStrategy
Empty
PartitionPlacementStrategy
Field | Description |
---|---|
partitions | int64 Acceptable values are 2 to 5, inclusive. |
Delete
Deletes the specified placement group.
rpc Delete (DeletePlacementGroupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeletePlacementGroupMetadata
Operation.response:google.protobuf.Empty
DeletePlacementGroupRequest
Field | Description |
---|---|
placement_group_id | string ID of the placement group to delete. To get the placement group ID, use PlacementGroupService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any<DeletePlacementGroupMetadata> 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any<google.protobuf.Empty> if operation finished successfully. |
DeletePlacementGroupMetadata
Field | Description |
---|---|
placement_group_id | string ID of the placement group that is being deleted. |
ListInstances
Lists instances for the specified placement group.
rpc ListInstances (ListPlacementGroupInstancesRequest) returns (ListPlacementGroupInstancesResponse)
ListPlacementGroupInstancesRequest
Field | Description |
---|---|
placement_group_id | string ID of the placement group to list instances for. To get the placement group ID, use PlacementGroupService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListPlacementGroupInstancesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. |
page_token | string Page token. To get the next page of results, set page_token to the ListPlacementGroupInstancesResponse.next_page_token returned by a previous list request. |
ListPlacementGroupInstancesResponse
Field | Description |
---|---|
instances[] | Instance Lists instances for the specified placement group. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is more than ListPlacementGroupInstancesRequest.page_size, use next_page_token as the value for the ListPlacementGroupInstancesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Instance
Field | Description |
---|---|
id | string ID of the instance. |
folder_id | string ID of the folder that the instance belongs to. |
created_at | google.protobuf.Timestamp |
name | string Name of the instance. 1-63 characters long. |
description | string Description of the instance. 0-256 characters long. |
labels | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
zone_id | string ID of the availability zone where the instance resides. |
platform_id | string ID of the hardware platform configuration for the instance. |
resources | Resources Computing resources of the instance such as the amount of memory and number of cores. |
status | enum Status Status of the instance.
|
metadata | map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata. |
metadata_options | MetadataOptions Options allow user to configure access to instance's metadata |
boot_disk | AttachedDisk Boot disk that is attached to the instance. |
secondary_disks[] | AttachedDisk Array of secondary disks that are attached to the instance. |
local_disks[] | AttachedLocalDisk Array of local disks that are attached to the instance. |
filesystems[] | AttachedFilesystem Array of filesystems that are attached to the instance. |
network_interfaces[] | NetworkInterface Array of network interfaces that are attached to the instance. |
gpu_settings | GpuSettings GPU settings |
fqdn | string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Scheduling policy configuration. |
service_account_id | string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request. |
network_settings | NetworkSettings Network Settings |
placement_policy | PlacementPolicy Placement policy configuration. |
Resources
Field | Description |
---|---|
memory | int64 The amount of memory available to the instance, specified in bytes. |
cores | int64 The number of cores available to the instance. |
core_fraction | int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core. |
gpus | int64 The number of GPUs available to the instance. |
MetadataOptions
Field | Description |
---|---|
gce_http_endpoint | enum MetadataOption Enabled access to GCE flavored metadata
|
aws_v1_http_endpoint | enum MetadataOption Enabled access to AWS flavored metadata (IMDSv1)
|
gce_http_token | enum MetadataOption Enabled access to IAM credentials with GCE flavored metadata
|
aws_v1_http_token | enum MetadataOption Enabled access to IAM credentials with AWS flavored metadata (IMDSv1)
|
AttachedDisk
Field | Description |
---|---|
mode | enum Mode Access mode to the Disk resource.
|
device_name | string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. |
auto_delete | bool Specifies whether the disk will be auto-deleted when the instance is deleted. |
disk_id | string ID of the disk that is attached to the instance. |
AttachedLocalDisk
Field | Description |
---|---|
size | int64 Size of the disk, specified in bytes. |
device_name | string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. |
AttachedFilesystem
Field | Description |
---|---|
mode | enum Mode Access mode to the filesystem.
|
device_name | string Name of the device representing the filesystem on the instance. The name should be used for referencing the filesystem from within the instance when it's being mounted, resized etc. |
filesystem_id | string ID of the filesystem that is attached to the instance. |
NetworkInterface
Field | Description |
---|---|
index | string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance. |
mac_address | string MAC address that is assigned to the network interface. |
subnet_id | string ID of the subnet. |
primary_v4_address | PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address | PrimaryAddress Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet. |
security_group_ids[] | string ID's of security groups attached to the interface |
PrimaryAddress
Field | Description |
---|---|
address | string An IPv4 internal network address that is assigned to the instance for this network interface. |
one_to_one_nat | OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up. |
dns_records[] | DnsRecord Internal DNS configuration |
OneToOneNat
Field | Description |
---|---|
address | string An external IP address associated with this instance. |
ip_version | enum IpVersion IP version for the external IP address.
|
dns_records[] | DnsRecord External DNS configuration |
DnsRecord
Field | Description |
---|---|
fqdn | string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id). |
dns_zone_id | string DNS zone id for the record (optional, if not set, some private zone is used). |
ttl | int64 DNS record ttl (optional, if not set, a reasonable default is used.) |
ptr | bool When true, indicates there is a corresponding auto-created PTR DNS record. |
GpuSettings
Field | Description |
---|---|
gpu_cluster_id | string Attach instance to specified GPU cluster. |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool True for short-lived compute instances. For more information, see Preemptible VMs. |
NetworkSettings
Field | Description |
---|---|
type | enum Type Network Type
|
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Placement group ID. |
host_affinity_rules[] | HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules. |
HostAffinityRule
Field | Description |
---|---|
key | string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId' |
op | enum Operator Include or exclude action |
values[] | string Affinity value or host ID or host group ID |
ListOperations
Lists operations for the specified placement group.
rpc ListOperations (ListPlacementGroupOperationsRequest) returns (ListPlacementGroupOperationsResponse)
ListPlacementGroupOperationsRequest
Field | Description |
---|---|
placement_group_id | string ID of the placement group to list operations for. To get the placement group ID, use PlacementGroupService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListPlacementGroupOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. |
page_token | string Page token. To get the next page of results, set page_token to the ListPlacementGroupOperationsResponse.next_page_token returned by a previous list request. |
ListPlacementGroupOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations for the specified placement group. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListPlacementGroupOperationsRequest.page_size, use the next_page_token as the value for the ListPlacementGroupOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | 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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any 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. |