Method update

HTTP request
Path parameters
Body parameters
Response

Modifies the specified MySQL cluster.

HTTP request

PATCH https://mdb.api.cloud.yandex.net/managed-mysql/v1alpha/clusters/{clusterId}

Path parameters

Parameter	Description
clusterId	Required. ID of the MySQL cluster to update. To get the MySQL cluster ID, use a list request. The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "configSpec": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "mysqlConfig_5_7": {
      "innodbBufferPoolSize": "integer",
      "maxConnections": "integer",
      "longQueryTime": "number"
    }
  },
  "name": "string"
}

Field	Description
updateMask	string Field mask that specifies which fields of the MySQL cluster should 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.
description	string New description of the MySQL cluster. The maximum string length in characters is 256.
labels	object Custom labels for the MySQL cluster as `key:value` pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". The new set of labels will completely replace the old ones. To add a label, request the current set with the get method, then send an update request with the new label added to the 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]`.
configSpec	object New configuration and resources for hosts in the cluster.
configSpec. version	string Version of MySQL used in the cluster. Possible values: 5.7
configSpec. resources	object Resources allocated to MySQL hosts.
configSpec. resources. resourcePresetId	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
configSpec. resources. diskSize	string (int64) Volume of the storage available to a host.
configSpec. resources. diskTypeId	string Type of the storage environment for the host. Possible values: network-ssd — network SSD drive, local-ssd — local SSD storage.
configSpec. backupWindowStart	object Time to start the daily backup, in the UTC timezone. Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
configSpec. backupWindowStart. hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
configSpec. backupWindowStart. minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
configSpec. backupWindowStart. seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
configSpec. backupWindowStart. nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
configSpec. mysqlConfig_5_7	object Configuration for a MySQL 5.7 cluster. Options and structure of `MysqlConfig5_7` reflects MySQL 5.7 configuration file
configSpec. mysqlConfig_5_7. innodbBufferPoolSize	integer (int64) Size of the InnoDB buffer pool used for caching table and index data. For details, see MySQL documentation for the parameter. The minimum value is 5242880.
configSpec. mysqlConfig_5_7. maxConnections	integer (int64) The maximum permitted number of simultaneous client connections. For details, see MySQL documentation for the variable. Acceptable values are 10 to 10000, inclusive.
configSpec. mysqlConfig_5_7. longQueryTime	number (double) Time that it takes to process a query before it is considered slow. For details, see MySQL documentation for the variable.
name	string New name for the cluster. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.

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.