Compute Cloud API, REST: DiskPlacementGroup.Get
Returns the specified placement group.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/diskPlacementGroups/{diskPlacementGroupId}
Path parameters
|
Field |
Description |
|
diskPlacementGroupId |
string Required field. ID of the placement group to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"zoneId": "string",
"status": "string",
// Includes only one of the fields `spreadPlacementStrategy`, `partitionPlacementStrategy`
"spreadPlacementStrategy": "object",
"partitionPlacementStrategy": {
"partitions": "string"
}
// end of the list of possible fields
}
|
Field |
Description |
|
id |
string ID of the placement group. |
|
folderId |
string ID of the folder that the placement 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 To work with values in this field, use the APIs described in the |
|
name |
string Name of the placement group. |
|
description |
string Description of the placement group. |
|
labels |
string Resource labels as |
|
zoneId |
string ID of the availability zone where the placement group resides. |
|
status |
enum (Status) Current status of the placement group
|
|
spreadPlacementStrategy |
object Distribute disks over distinct failure domains. Includes only one of the fields Placement strategy. |
|
partitionPlacementStrategy |
DiskPartitionPlacementStrategy Distribute disks over partitions. Includes only one of the fields Placement strategy. |
DiskPartitionPlacementStrategy
|
Field |
Description |
|
partitions |
string (int64) |