Compute Cloud API, gRPC: DiskPlacementGroupService

A set of methods for managing DiskPlacementGroup resources.

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.
ListDisks	Lists disks for the specified placement group.
ListOperations	Lists operations for the specified placement group.

Calls DiskPlacementGroupServiceCalls DiskPlacementGroupService

GetGet

Returns the specified placement group.

rpc Get (GetDiskPlacementGroupRequest) returns (DiskPlacementGroup)

GetDiskPlacementGroupRequestGetDiskPlacementGroupRequest

Field	Description
disk_placement_group_id	string Required. ID of the placement group to return. To get the placement group ID, use DiskPlacementGroupService.List request. The maximum string length in characters is 50.

DiskPlacementGroupDiskPlacementGroup

Field	Description
id	string ID of the placement group.
folder_id	string ID of the folder that the placement group belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the placement group. The name is unique within the folder.
description	string Description of the placement group.
labels	map<string,string> Resource labels as key:value pairs.
zone_id	string ID of the availability zone where the placement group resides.
status	enum Status Current status of the placement group
placement_strategy	oneof: spread_placement_strategy or partition_placement_strategy Placement strategy.
spread_placement_strategy	DiskSpreadPlacementStrategy Distribute disks over distinct failure domains.
partition_placement_strategy	DiskPartitionPlacementStrategy Distribute disks over partitions.

DiskSpreadPlacementStrategyDiskSpreadPlacementStrategy

Empty.

DiskPartitionPlacementStrategyDiskPartitionPlacementStrategy

Field	Description
partitions	int64

ListList

Retrieves the list of placement groups in the specified folder.

rpc List (ListDiskPlacementGroupsRequest) returns (ListDiskPlacementGroupsResponse)

ListDiskPlacementGroupsRequestListDiskPlacementGroupsRequest

Field	Description
folder_id	string Required. ID of the folder to list placement groups in. To get the folder ID, use resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
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 ListDiskPlacementGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListDiskPlacementGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters resources listed in the response. The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]]. Each condition has the form <field> <operator> <value>, where: <field> is the field name. Currently you can use filtering only on the limited number of fields. <operator> is a logical operator, one of =, !=, IN, NOT IN. <value> represents a value. String values should be written in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash). The maximum string length in characters is 1000.
order_by	string By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. The default sorting order is ascending The maximum string length in characters is 100.

ListDiskPlacementGroupsResponseListDiskPlacementGroupsResponse

Field	Description
disk_placement_groups[]	DiskPlacementGroup Lists placement groups for the specified folder.
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 ListDiskPlacementGroupsRequest.page_size, use next_page_token as the value for the ListDiskPlacementGroupsRequest.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.

DiskPlacementGroupDiskPlacementGroup

Field	Description
id	string ID of the placement group.
folder_id	string ID of the folder that the placement group belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the placement group. The name is unique within the folder.
description	string Description of the placement group.
labels	map<string,string> Resource labels as key:value pairs.
zone_id	string ID of the availability zone where the placement group resides.
status	enum Status Current status of the placement group
placement_strategy	oneof: spread_placement_strategy or partition_placement_strategy Placement strategy.
spread_placement_strategy	DiskSpreadPlacementStrategy Distribute disks over distinct failure domains.
partition_placement_strategy	DiskPartitionPlacementStrategy Distribute disks over partitions.

DiskSpreadPlacementStrategyDiskSpreadPlacementStrategy

Empty.

DiskPartitionPlacementStrategyDiskPartitionPlacementStrategy

Field	Description
partitions	int64

CreateCreate

Creates a placement group in the specified folder.

rpc Create (CreateDiskPlacementGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateDiskPlacementGroupMetadata

    Operation.response:DiskPlacementGroup

CreateDiskPlacementGroupRequestCreateDiskPlacementGroupRequest

Field	Description
folder_id	string Required. ID of the folder to create a placement group in. To get the folder ID, use a resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name	string Name of the placement group. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description	string Description of the placement group. The maximum string length in characters is 256.
labels	map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.
zone_id	string Required. ID of the availability zone where the placement group resides. To get a list of available zones use the compute.v1.ZoneService.List request. The maximum string length in characters is 50.
placement_strategy	oneof: spread_placement_strategy or partition_placement_strategy Placement strategy.
spread_placement_strategy	DiskSpreadPlacementStrategy Distribute disks over distinct failure domains.
partition_placement_strategy	DiskPartitionPlacementStrategy Distribute disks over partitions.

DiskSpreadPlacementStrategyDiskSpreadPlacementStrategy

Empty.

DiskPartitionPlacementStrategyDiskPartitionPlacementStrategy

Field	Description
partitions	int64

OperationOperation

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<CreateDiskPlacementGroupMetadata> 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<DiskPlacementGroup> if operation finished successfully.

CreateDiskPlacementGroupMetadataCreateDiskPlacementGroupMetadata

Field	Description
disk_placement_group_id	string ID of the placement group that is being created.

DiskPlacementGroupDiskPlacementGroup

Field	Description
id	string ID of the placement group.
folder_id	string ID of the folder that the placement group belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the placement group. The name is unique within the folder.
description	string Description of the placement group.
labels	map<string,string> Resource labels as key:value pairs.
zone_id	string ID of the availability zone where the placement group resides.
status	enum Status Current status of the placement group
placement_strategy	oneof: spread_placement_strategy or partition_placement_strategy Placement strategy.
spread_placement_strategy	DiskSpreadPlacementStrategy Distribute disks over distinct failure domains.
partition_placement_strategy	DiskPartitionPlacementStrategy Distribute disks over partitions.

UpdateUpdate

Updates the specified placement group.

rpc Update (UpdateDiskPlacementGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateDiskPlacementGroupMetadata

    Operation.response:DiskPlacementGroup

UpdateDiskPlacementGroupRequestUpdateDiskPlacementGroupRequest

Field	Description
disk_placement_group_id	string Required. ID of the placement group to update. To get the placement group ID, use an DiskPlacementGroupService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the DiskPlacementGroup resource are going to be updated.
name	string Name of the placement group. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description	string Description of the placement group. The maximum string length in characters is 256.
labels	map<string,string> Resource labels as key:value pairs. The existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.

OperationOperation

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<UpdateDiskPlacementGroupMetadata> 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<DiskPlacementGroup> if operation finished successfully.

UpdateDiskPlacementGroupMetadataUpdateDiskPlacementGroupMetadata

Field	Description
disk_placement_group_id	string ID of the placement group that is being updated.

DiskPlacementGroupDiskPlacementGroup

Field	Description
id	string ID of the placement group.
folder_id	string ID of the folder that the placement group belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the placement group. The name is unique within the folder.
description	string Description of the placement group.
labels	map<string,string> Resource labels as key:value pairs.
zone_id	string ID of the availability zone where the placement group resides.
status	enum Status Current status of the placement group
placement_strategy	oneof: spread_placement_strategy or partition_placement_strategy Placement strategy.
spread_placement_strategy	DiskSpreadPlacementStrategy Distribute disks over distinct failure domains.
partition_placement_strategy	DiskPartitionPlacementStrategy Distribute disks over partitions.

DiskSpreadPlacementStrategyDiskSpreadPlacementStrategy

Empty.

DiskPartitionPlacementStrategyDiskPartitionPlacementStrategy

Field	Description
partitions	int64

DeleteDelete

Deletes the specified placement group.

rpc Delete (DeleteDiskPlacementGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteDiskPlacementGroupMetadata

    Operation.response:google.protobuf.Empty

DeleteDiskPlacementGroupRequestDeleteDiskPlacementGroupRequest

Field	Description
disk_placement_group_id	string Required. ID of the placement group to delete. To get the placement group ID, use DiskPlacementGroupService.List request. The maximum string length in characters is 50.

OperationOperation

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

DeleteDiskPlacementGroupMetadataDeleteDiskPlacementGroupMetadata

Field	Description
disk_placement_group_id	string ID of the placement group that is being deleted.

ListDisksListDisks

Lists disks for the specified placement group.

rpc ListDisks (ListDiskPlacementGroupDisksRequest) returns (ListDiskPlacementGroupDisksResponse)

ListDiskPlacementGroupDisksRequestListDiskPlacementGroupDisksRequest

Field	Description
disk_placement_group_id	string Required. ID of the placement group to list disks for. To get the placement group ID, use DiskPlacementGroupService.List request. The maximum string length in characters is 50.
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 ListDiskPlacementGroupDisksResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListDiskPlacementGroupDisksResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListDiskPlacementGroupDisksResponseListDiskPlacementGroupDisksResponse

Field	Description
disks[]	Disk Lists disks 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 ListDiskPlacementGroupDisksRequest.page_size, use next_page_token as the value for the ListDiskPlacementGroupDisksRequest.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.

DiskDisk

Field	Description
id	string ID of the disk.
folder_id	string ID of the folder that the disk belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the disk. 1-63 characters long.
description	string Description of the disk. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
type_id	string ID of the disk type.
zone_id	string ID of the availability zone where the disk resides.
size	int64 Size of the disk, specified in bytes.
block_size	int64 Block size of the disk, specified in bytes.
product_ids[]	string License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine. The correct license ID is generated by the platform. IDs are inherited by new resources created from this resource. If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Object Storage, the license IDs will be lost. You can specify them in the compute.v1.ImageService.Create request.
status	enum Status Current status of the disk. CREATING: Disk is being created. READY: Disk is ready to use. ERROR: Disk encountered a problem and cannot operate. DELETING: Disk is being deleted.
source	oneof: source_image_id or source_snapshot_id
source_image_id	string ID of the image that was used for disk creation.
source_snapshot_id	string ID of the snapshot that was used for disk creation.
instance_ids[]	string Array of instances to which the disk is attached.
disk_placement_policy	DiskPlacementPolicy Placement policy configuration.

DiskPlacementPolicyDiskPlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
placement_group_partition	int64

ListOperationsListOperations

Lists operations for the specified placement group.

rpc ListOperations (ListDiskPlacementGroupOperationsRequest) returns (ListDiskPlacementGroupOperationsResponse)

ListDiskPlacementGroupOperationsRequestListDiskPlacementGroupOperationsRequest

Field	Description
disk_placement_group_id	string Required. ID of the placement group to list operations for. To get the placement group ID, use DiskPlacementGroupService.List request. The maximum string length in characters is 50.
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 ListDiskPlacementGroupOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListDiskPlacementGroupOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListDiskPlacementGroupOperationsResponseListDiskPlacementGroupOperationsResponse

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 ListDiskPlacementGroupOperationsRequest.page_size, use the next_page_token as the value for the ListDiskPlacementGroupOperationsRequest.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.

OperationOperation

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.