Compute Cloud API, REST: DiskPlacementGroup.Update
Updates the specified placement group.
HTTP request
PATCH https://compute.api.cloud.yandex.net/compute/v1/diskPlacementGroups/{diskPlacementGroupId}
Path parameters
Field |
Description |
diskPlacementGroupId |
string Required field. ID of the placement group to update. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "string"
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string Name of the placement group. |
description |
string Description of the placement group. |
labels |
string Resource labels as The existing set of |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"diskPlacementGroupId": "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",
// Includes only one of the fields `spreadPlacementStrategy`, `partitionPlacementStrategy`
"spreadPlacementStrategy": "object",
"partitionPlacementStrategy": {
"partitions": "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 To work with values in this field, use the APIs described in the |
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 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
UpdateDiskPlacementGroupMetadata Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateDiskPlacementGroupMetadata
Field |
Description |
diskPlacementGroupId |
string ID of the placement group that is being updated. |
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. |
DiskPlacementGroup
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 String in RFC3339 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) |