Method update

Статья создана

HTTP request
Path parameters
Body parameters
Response

Updates the specified disk.

HTTP request

PATCH https://compute.api.cloud.yandex.net/compute/v1/disks/{diskId}

Path parameters

Parameter	Description
diskId	Required. ID of the Disk resource to update. To get the disk ID use a list request. The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "size": "string",
  "diskPlacementPolicy": {
    "placementGroupId": "string"
  }
}

Field	Description
updateMask	string Field mask that specifies which fields of the Disk resource are going to be updated. A comma-separated names off ALL fields to be updated. Оnly the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string Name of the disk. Value must match the regular expression `\|[a-z]([-a-z0-9]{0,61}[a-z0-9])?`.
description	string Description of the disk. The maximum string length in characters is 256.
labels	object Resource labels as `key:value` pairs. Existing set of `labels` is completely replaced by the provided set. No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_./\@0-9a-z]`. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_./\@0-9a-z]`.
size	string (int64) Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive.
diskPlacementPolicy	object Placement policy configuration.
diskPlacementPolicy. placementGroupId	string Placement group ID.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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 text format.
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 text format.
done	boolean (boolean) 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	object 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	object The error result of the operation in case of failure or cancellation. includes only one of the fields `error`, `response` The error result of the operation in case of failure or cancellation.
error. code	integer (int32) Error code. An enum value of google.rpc.Code.
error. message	string An error message.
error. details[]	object A list of messages that carry the error details.
response	object includes only one of the fields `error`, `response` 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.

Method update

HTTP request

Path parameters

Body parameters

Response

Была ли статья полезна?