Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Managed Service for MySQL

Method update

Статья создана
,
улучшена

Updates a cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the cluster to update. To get this ID, make 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"
    },
    "access": {
      "dataLens": true,
      "webSql": true,
      "dataTransfer": true
    },
    "performanceDiagnostics": {
      "enabled": true,
      "sessionsSamplingInterval": "string",
      "statementsSamplingInterval": "string"
    },

    // `configSpec` includes only one of the fields `mysqlConfig_5_7`, `mysqlConfig_8_0`
    "mysqlConfig_5_7": {
      "innodbBufferPoolSize": "integer",
      "maxConnections": "integer",
      "longQueryTime": "number",
      "generalLog": true,
      "auditLog": true,
      "sqlMode": [
        "string"
      ],
      "maxAllowedPacket": "integer",
      "defaultAuthenticationPlugin": "string",
      "innodbFlushLogAtTrxCommit": "integer",
      "innodbLockWaitTimeout": "integer",
      "transactionIsolation": "string",
      "innodbPrintAllDeadlocks": true,
      "netReadTimeout": "integer",
      "netWriteTimeout": "integer",
      "groupConcatMaxLen": "integer",
      "tmpTableSize": "integer",
      "maxHeapTableSize": "integer",
      "defaultTimeZone": "string",
      "characterSetServer": "string",
      "collationServer": "string",
      "innodbAdaptiveHashIndex": true,
      "innodbNumaInterleave": true,
      "innodbLogBufferSize": "integer",
      "innodbLogFileSize": "integer",
      "innodbIoCapacity": "integer",
      "innodbIoCapacityMax": "integer",
      "innodbReadIoThreads": "integer",
      "innodbWriteIoThreads": "integer",
      "innodbPurgeThreads": "integer",
      "innodbThreadConcurrency": "integer",
      "innodbTempDataFileMaxSize": "integer",
      "threadCacheSize": "integer",
      "threadStack": "integer",
      "joinBufferSize": "integer",
      "sortBufferSize": "integer",
      "tableDefinitionCache": "integer",
      "tableOpenCache": "integer",
      "tableOpenCacheInstances": "integer",
      "explicitDefaultsForTimestamp": true,
      "autoIncrementIncrement": "integer",
      "autoIncrementOffset": "integer",
      "syncBinlog": "integer",
      "binlogCacheSize": "integer",
      "binlogGroupCommitSyncDelay": "integer",
      "binlogRowImage": "string",
      "binlogRowsQueryLogEvents": true,
      "rplSemiSyncMasterWaitForSlaveCount": "integer",
      "slaveParallelType": "string",
      "slaveParallelWorkers": "integer",
      "mdbPreserveBinlogBytes": "integer",
      "interactiveTimeout": "integer",
      "waitTimeout": "integer",
      "mdbOfflineModeEnableLag": "integer",
      "mdbOfflineModeDisableLag": "integer",
      "rangeOptimizerMaxMemSize": "integer",
      "slowQueryLog": true,
      "slowQueryLogAlwaysWriteTime": "number",
      "logSlowRateType": "string",
      "logSlowRateLimit": "integer",
      "logSlowSpStatements": true,
      "logSlowFilter": [
        "string"
      ],
      "mdbPriorityChoiceMaxLag": "integer",
      "innodbPageSize": "integer",
      "innodbOnlineAlterLogMaxSize": "integer",
      "innodbFtMinTokenSize": "integer",
      "innodbFtMaxTokenSize": "integer",
      "lowerCaseTableNames": "integer",
      "showCompatibility_56": true,
      "maxSpRecursionDepth": "integer",
      "innodbCompressionLevel": "integer"
    },
    "mysqlConfig_8_0": {
      "innodbBufferPoolSize": "integer",
      "maxConnections": "integer",
      "longQueryTime": "number",
      "generalLog": true,
      "auditLog": true,
      "sqlMode": [
        "string"
      ],
      "maxAllowedPacket": "integer",
      "defaultAuthenticationPlugin": "string",
      "innodbFlushLogAtTrxCommit": "integer",
      "innodbLockWaitTimeout": "integer",
      "transactionIsolation": "string",
      "innodbPrintAllDeadlocks": true,
      "netReadTimeout": "integer",
      "netWriteTimeout": "integer",
      "groupConcatMaxLen": "integer",
      "tmpTableSize": "integer",
      "maxHeapTableSize": "integer",
      "defaultTimeZone": "string",
      "characterSetServer": "string",
      "collationServer": "string",
      "innodbAdaptiveHashIndex": true,
      "innodbNumaInterleave": true,
      "innodbLogBufferSize": "integer",
      "innodbLogFileSize": "integer",
      "innodbIoCapacity": "integer",
      "innodbIoCapacityMax": "integer",
      "innodbReadIoThreads": "integer",
      "innodbWriteIoThreads": "integer",
      "innodbPurgeThreads": "integer",
      "innodbThreadConcurrency": "integer",
      "innodbTempDataFileMaxSize": "integer",
      "threadCacheSize": "integer",
      "threadStack": "integer",
      "joinBufferSize": "integer",
      "sortBufferSize": "integer",
      "tableDefinitionCache": "integer",
      "tableOpenCache": "integer",
      "tableOpenCacheInstances": "integer",
      "explicitDefaultsForTimestamp": true,
      "autoIncrementIncrement": "integer",
      "autoIncrementOffset": "integer",
      "syncBinlog": "integer",
      "binlogCacheSize": "integer",
      "binlogGroupCommitSyncDelay": "integer",
      "binlogRowImage": "string",
      "binlogRowsQueryLogEvents": true,
      "rplSemiSyncMasterWaitForSlaveCount": "integer",
      "slaveParallelType": "string",
      "slaveParallelWorkers": "integer",
      "regexpTimeLimit": "integer",
      "mdbPreserveBinlogBytes": "integer",
      "interactiveTimeout": "integer",
      "waitTimeout": "integer",
      "mdbOfflineModeEnableLag": "integer",
      "mdbOfflineModeDisableLag": "integer",
      "rangeOptimizerMaxMemSize": "integer",
      "slowQueryLog": true,
      "slowQueryLogAlwaysWriteTime": "number",
      "logSlowRateType": "string",
      "logSlowRateLimit": "integer",
      "logSlowSpStatements": true,
      "logSlowFilter": [
        "string"
      ],
      "mdbPriorityChoiceMaxLag": "integer",
      "innodbPageSize": "integer",
      "innodbOnlineAlterLogMaxSize": "integer",
      "innodbFtMinTokenSize": "integer",
      "innodbFtMaxTokenSize": "integer",
      "lowerCaseTableNames": "integer",
      "maxSpRecursionDepth": "integer",
      "innodbCompressionLevel": "integer"
    },
    // end of the list of possible fields`configSpec`

  },
  "name": "string",
  "maintenanceWindow": {

    // `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": {},
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    },
    // end of the list of possible fields`maintenanceWindow`

  },
  "securityGroupIds": [
    "string"
  ],
  "deletionProtection": true
}
Field Description
updateMask string

Field mask that specifies which settings of the 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 cluster.

The maximum string length in characters is 256.
labels object

New set of custom labels for the cluster as key:value pairs.

This set will completely replace the current one. To add a label, request the current label set with the get request, then send an update request with the new label added to the current 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 of the cluster.
configSpec.
version		 string

Version of MySQL used in the cluster.

Possible values: 5.7, 8.0.
configSpec.
resources		 object
Resource preset for the cluster hosts.

Cluster resource preset.
configSpec.
resources.
resourcePresetId		 string

ID of the resource preset that defines available computational resources (vCPU, RAM, etc.) for a cluster host.

All available presets are listed in the documentation.
configSpec.
resources.
diskSize		 string (int64)

Volume of the storage (for each cluster host, in bytes).
configSpec.
resources.
diskTypeId		 string

Type of the storage.

Possible values:

  • network-hdd - standard network storage
  • network-ssd - fast network storage
  • network-ssd-nonreplicated - fast network nonreplicated storage
  • local-ssd - fast local storage.

See the documentation for details.
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.
access		 object
Access policy for external services. If the specific services need to access the cluster, then set the necessary values in this policy.
configSpec.
access.
dataLens		 boolean (boolean)

Allows access from DataLens.

See the documentation for details.
configSpec.
access.
webSql		 boolean (boolean)

Allows SQL queries to the cluster databases from Yandex Cloud management console.

See the documentation for details.
configSpec.
access.
dataTransfer		 boolean (boolean)

Allow access for DataTransfer.
configSpec.
performanceDiagnostics		 object
Configuration of the performance diagnostics service.
configSpec.
performanceDiagnostics.
enabled		 boolean (boolean)

Flag that shows if performance statistics gathering is enabled for the cluster.
configSpec.
performanceDiagnostics.
sessionsSamplingInterval		 string (int64)

Interval (in seconds) for my_session sampling.

Acceptable values are 1 to 86400, inclusive.
configSpec.
performanceDiagnostics.
statementsSamplingInterval		 string (int64)

Interval (in seconds) for my_statements sampling.

Acceptable values are 1 to 86400, inclusive.
configSpec.
mysqlConfig_5_7		 object
Configuration for a MySQL 5.7 cluster.
configSpec includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0

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.

See MySQL documentation for details.

The minimum value is 5242880.
configSpec.
mysqlConfig_5_7.
maxConnections		 integer (int64)

The maximum permitted number of simultaneous client connections.

See MySQL documentation for details.

Acceptable values are 10 to 16384, inclusive.
configSpec.
mysqlConfig_5_7.
longQueryTime		 number (double)

Time that it takes to process a query before it is considered slow.

See MySQL documentation for details.

Acceptable values are 0 to 3600, inclusive.
configSpec.
mysqlConfig_5_7.
generalLog		 boolean (boolean)

Enable writing of general query log of MySQL.

See MySQL documentation for details.
configSpec.
mysqlConfig_5_7.
auditLog		 boolean (boolean)

Enable writing of audit log of MySQL.

See MySQL documentation for details.
configSpec.
mysqlConfig_5_7.
sqlMode[]		 string

Server SQL mode of MySQL.

See MySQL documentation for details.
configSpec.
mysqlConfig_5_7.
maxAllowedPacket		 integer (int64)

The maximum size in bytes of one packet.

See MySQL documentation for details.

Acceptable values are 1024 to 1073741824, inclusive.
configSpec.
mysqlConfig_5_7.
defaultAuthenticationPlugin		 string

Authentication plugin used in the managed MySQL cluster.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_default_authentication_plugin for details.
configSpec.
mysqlConfig_5_7.
innodbFlushLogAtTrxCommit		 integer (int64)

Transaction log flush behaviour.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_flush_log_at_trx_commit for details.

Acceptable values are 1 to 2, inclusive.
configSpec.
mysqlConfig_5_7.
innodbLockWaitTimeout		 integer (int64)

Max time in seconds for a transaction to wait for a row lock.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_lock_wait_timeout for details.

Acceptable values are 1 to 28800, inclusive.
configSpec.
mysqlConfig_5_7.
transactionIsolation		 string

Default transaction isolation level.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_transaction_isolation for details.
configSpec.
mysqlConfig_5_7.
innodbPrintAllDeadlocks		 boolean (boolean)

Print information about deadlocks in error log.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_print_all_deadlocks for details.
configSpec.
mysqlConfig_5_7.
netReadTimeout		 integer (int64)

The number of seconds to wait for more data from a connection before aborting the read.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_net_read_timeout for details.

Acceptable values are 1 to 1200, inclusive.
configSpec.
mysqlConfig_5_7.
netWriteTimeout		 integer (int64)

The number of seconds to wait for a block to be written to a connection before aborting the write.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_net_write_timeout for details.

Acceptable values are 1 to 1200, inclusive.
configSpec.
mysqlConfig_5_7.
groupConcatMaxLen		 integer (int64)

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_group_concat_max_len for details.

Acceptable values are 4 to 33554432, inclusive.
configSpec.
mysqlConfig_5_7.
tmpTableSize		 integer (int64)

The maximum size of internal in-memory temporary tables.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_tmp_table_size for details.

Acceptable values are 1024 to 536870912, inclusive.
configSpec.
mysqlConfig_5_7.
maxHeapTableSize		 integer (int64)

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_max_heap_table_size for details.

Acceptable values are 16384 to 536870912, inclusive.
configSpec.
mysqlConfig_5_7.
defaultTimeZone		 string

The servers default time zone.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-options.html#option_mysqld_default-time-zone for details.
configSpec.
mysqlConfig_5_7.
characterSetServer		 string

The servers default character set.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_character_set_server for details.
configSpec.
mysqlConfig_5_7.
collationServer		 string

The server default collation.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_collation_server for details.
configSpec.
mysqlConfig_5_7.
innodbAdaptiveHashIndex		 boolean (boolean)

Enables InnoDB adaptive hash index.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_adaptive_hash_index for details.
configSpec.
mysqlConfig_5_7.
innodbNumaInterleave		 boolean (boolean)

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_numa_interleave for details.
configSpec.
mysqlConfig_5_7.
innodbLogBufferSize		 integer (int64)

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_log_buffer_size for details.

Acceptable values are 1048576 to 268435456, inclusive.
configSpec.
mysqlConfig_5_7.
innodbLogFileSize		 integer (int64)

The size in bytes of the single InnoDB Redo log file.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_log_file_size for details.

Acceptable values are 268435456 to 4294967296, inclusive.
configSpec.
mysqlConfig_5_7.
innodbIoCapacity		 integer (int64)

Limits IO available for InnoDB background tasks.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_io_capacity for details.

Acceptable values are 100 to 100000, inclusive.
configSpec.
mysqlConfig_5_7.
innodbIoCapacityMax		 integer (int64)

Limits IO available for InnoDB background tasks.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_io_capacity_max for details.

Acceptable values are 100 to 100000, inclusive.
configSpec.
mysqlConfig_5_7.
innodbReadIoThreads		 integer (int64)

The number of I/O threads for read operations in InnoDB.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_read_io_threads for details.

Acceptable values are 1 to 16, inclusive.
configSpec.
mysqlConfig_5_7.
innodbWriteIoThreads		 integer (int64)

The number of I/O threads for write operations in InnoDB.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_write_io_threads for details.

Acceptable values are 1 to 16, inclusive.
configSpec.
mysqlConfig_5_7.
innodbPurgeThreads		 integer (int64)

The number of background threads devoted to the InnoDB purge operation.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_purge_threads for details.

Acceptable values are 1 to 16, inclusive.
configSpec.
mysqlConfig_5_7.
innodbThreadConcurrency		 integer (int64)

Defines the maximum number of threads permitted inside of InnoDB.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_thread_concurrency for details.

Acceptable values are 0 to 1000, inclusive.
configSpec.
mysqlConfig_5_7.
innodbTempDataFileMaxSize		 integer (int64)

Limits the max size of InnoDB temp tablespace.

See [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_temp_data_file_path for details.

Acceptable values are 0 to 107374182400, inclusive.
configSpec.
mysqlConfig_5_7.
threadCacheSize		 integer (int64)

A number of threads the server should cache for reuse.

See MySQL documentation for details.

Acceptable values are 10 to 10000, inclusive.
configSpec.
mysqlConfig_5_7.
threadStack		 integer (int64)

The stack size for each thread. The default is large enough for normal operation.

See MySQL documentation for details.

Acceptable values are 131072 to 16777216, inclusive.
configSpec.
mysqlConfig_5_7.
joinBufferSize		 integer (int64)

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans.

See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.
configSpec.
mysqlConfig_5_7.
sortBufferSize		 integer (int64)

Each session that must perform a sort allocates a buffer of this size.

See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.
configSpec.
mysqlConfig_5_7.
tableDefinitionCache		 integer (int64)

The number of table definitions that can be stored in the definition cache.

See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.
configSpec.
mysqlConfig_5_7.
tableOpenCache		 integer (int64)

The number of open tables for all threads.

See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.
configSpec.
mysqlConfig_5_7.
tableOpenCacheInstances		 integer (int64)

The number of open tables cache instances.

See MySQL documentation for details.

Acceptable values are 1 to 32, inclusive.
configSpec.
mysqlConfig_5_7.
explicitDefaultsForTimestamp		 boolean (boolean)

Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.

See MySQL documentation for details.
configSpec.
mysqlConfig_5_7.
autoIncrementIncrement		 integer (int64)

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.
configSpec.
mysqlConfig_5_7.
autoIncrementOffset		 integer (int64)

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.
configSpec.
mysqlConfig_5_7.
syncBinlog		 integer (int64)

Controls how often the MySQL server synchronizes the binary log to disk.

See MySQL documentation for details.

Acceptable values are 0 to 4096, inclusive.
configSpec.
mysqlConfig_5_7.
binlogCacheSize		 integer (int64)

The size of the cache to hold changes to the binary log during a transaction.

See MySQL documentation for details.

Acceptable values are 4096 to 67108864, inclusive.
configSpec.
mysqlConfig_5_7.
binlogGroupCommitSyncDelay		 integer (int64)

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.

See MySQL documentation for the variable for details.

Acceptable values are 0 to 50000, inclusive.
configSpec.
mysqlConfig_5_7.
binlogRowImage		 string

For MySQL row-based replication, this variable determines how row images are written to the binary log.

See MySQL documentation for details.
configSpec.
mysqlConfig_5_7.
binlogRowsQueryLogEvents		 boolean (boolean)

When enabled, it causes the server to write informational log events such as row query log events into its binary log.

See MySQL documentation for details.
configSpec.
mysqlConfig_5_7.
rplSemiSyncMasterWaitForSlaveCount		 integer (int64)

The number of replica acknowledgments the source must receive per transaction before proceeding.

See MySQL documentation for details.

Acceptable values are 1 to 2, inclusive.
configSpec.
mysqlConfig_5_7.
slaveParallelType		 string

When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.

See MySQL documentation for details.
configSpec.
mysqlConfig_5_7.
slaveParallelWorkers		 integer (int64)

Sets the number of applier threads for executing replication transactions in parallel.

See MySQL documentation for details.

Acceptable values are 0 to 64, inclusive.
configSpec.
mysqlConfig_5_7.
mdbPreserveBinlogBytes		 integer (int64)

The size of the binary log to hold.

Acceptable values are 1073741824 to 1099511627776, inclusive.
configSpec.
mysqlConfig_5_7.
interactiveTimeout		 integer (int64)

The number of seconds the server waits for activity on an interactive connection before closing it.

See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.
configSpec.
mysqlConfig_5_7.
waitTimeout		 integer (int64)

The number of seconds the server waits for activity on a noninteractive connection before closing it.

See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.
configSpec.
mysqlConfig_5_7.
mdbOfflineModeEnableLag		 integer (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

Acceptable values are 600 to 432000, inclusive.
configSpec.
mysqlConfig_5_7.
mdbOfflineModeDisableLag		 integer (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'. Should be less than mdb_offline_mode_enable_lag value.

Acceptable values are 60 to 86400, inclusive.
configSpec.
mysqlConfig_5_7.
rangeOptimizerMaxMemSize		 integer (int64)

The limit on memory consumption for the range optimizer.

See MySQL documentation for details.

Acceptable values are 1048576 to 268435456, inclusive.
configSpec.
mysqlConfig_5_7.
slowQueryLog		 boolean (boolean)

Manages slow query log.

See MySQL documentation for details.
configSpec.
mysqlConfig_5_7.
slowQueryLogAlwaysWriteTime		 number (double)

Query execution time, after which query to be logged unconditionally, that is, `log_slow_rate_limit`` will not apply to it.

See Percona documentation for details.
configSpec.
mysqlConfig_5_7.
logSlowRateType		 string

Specifies slow log granularity for log_slow_rate_limit values QUERY or SESSION.

See Percona documentation for details.
configSpec.
mysqlConfig_5_7.
logSlowRateLimit		 integer (int64)

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.

See Percona documentation for details.

Acceptable values are 1 to 1000, inclusive.
configSpec.
mysqlConfig_5_7.
logSlowSpStatements		 boolean (boolean)

When TRUE, statements executed by stored procedures are logged to the slow log.

See Percona documentation for details.
configSpec.
mysqlConfig_5_7.
logSlowFilter[]		 string

Filters the slow log by the query's execution plan.

See Percona documentation for details.
configSpec.
mysqlConfig_5_7.
mdbPriorityChoiceMaxLag		 integer (int64)

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from". Should be less than mdb_offline_mode_disable_lag.

Acceptable values are 0 to 86400, inclusive.
configSpec.
mysqlConfig_5_7.
innodbPageSize		 integer (int64)

Specifies the page size for InnoDB tablespaces.

For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 65536, inclusive.
configSpec.
mysqlConfig_5_7.
innodbOnlineAlterLogMaxSize		 integer (int64)

The limit in bytes on the size of the temporary log files used during online DDL operations

For details, see MySQL documentation for the variable.

Acceptable values are 65536 to 107374182400, inclusive.
configSpec.
mysqlConfig_5_7.
innodbFtMinTokenSize		 integer (int64)

Minimum length of words that are stored in an InnoDB FULLTEXT index

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 16, inclusive.
configSpec.
mysqlConfig_5_7.
innodbFtMaxTokenSize		 integer (int64)

Maximum length of words that are stored in an InnoDB FULLTEXT index

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 84, inclusive.
configSpec.
mysqlConfig_5_7.
lowerCaseTableNames		 integer (int64)

Table names storage and comparison strategy

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1, inclusive.
configSpec.
mysqlConfig_5_7.
showCompatibility_56		 boolean (boolean)

Manages MySQL 5.6 compatibility

For details, see MySQL documentation for the variable.
configSpec.
mysqlConfig_5_7.
maxSpRecursionDepth		 integer (int64)

The number of times that any given stored procedure may be called recursively.

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 255, inclusive.
configSpec.
mysqlConfig_5_7.
innodbCompressionLevel		 integer (int64)

The level of zlib compression to use for InnoDB compressed tables and indexes.

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 9, inclusive.
configSpec.
mysqlConfig_8_0		 object
Configuration for a MySQL 8.0 cluster.
configSpec includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file.
configSpec.
mysqlConfig_8_0.
innodbBufferPoolSize		 integer (int64)

Size of the InnoDB buffer pool used for caching table and index data.

See MySQL documentation for details.

The minimum value is 5242880.
configSpec.
mysqlConfig_8_0.
maxConnections		 integer (int64)

The maximum permitted number of simultaneous client connections.

See MySQL documentation for details.

Acceptable values are 10 to 16384, inclusive.
configSpec.
mysqlConfig_8_0.
longQueryTime		 number (double)

Time that it takes to process a query before it is considered slow.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
generalLog		 boolean (boolean)

Enable writing of general query log of MySQL.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
auditLog		 boolean (boolean)

Enable writing of audit log of MySQL.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
sqlMode[]		 string

Server SQL mode of MySQL.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
maxAllowedPacket		 integer (int64)

The maximum size in bytes of one packet.

See MySQL documentation for details.

Acceptable values are 1024 to 1073741824, inclusive.
configSpec.
mysqlConfig_8_0.
defaultAuthenticationPlugin		 string

Authentication plugin used in the managed MySQL cluster.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_default_authentication_plugin for details.
configSpec.
mysqlConfig_8_0.
innodbFlushLogAtTrxCommit		 integer (int64)

Transaction log flush behaviour.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_flush_log_at_trx_commit for details.

Acceptable values are 1 to 2, inclusive.
configSpec.
mysqlConfig_8_0.
innodbLockWaitTimeout		 integer (int64)

Max time in seconds for a transaction to wait for a row lock.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_lock_wait_timeout for details.

Acceptable values are 1 to 28800, inclusive.
configSpec.
mysqlConfig_8_0.
transactionIsolation		 string

Default transaction isolation level.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_transaction_isolation for details.
configSpec.
mysqlConfig_8_0.
innodbPrintAllDeadlocks		 boolean (boolean)

Print information about deadlocks in error log.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_print_all_deadlocks for details.
configSpec.
mysqlConfig_8_0.
netReadTimeout		 integer (int64)

The number of seconds to wait for more data from a connection before aborting the read.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_net_read_timeout for details.

Acceptable values are 1 to 1200, inclusive.
configSpec.
mysqlConfig_8_0.
netWriteTimeout		 integer (int64)

The number of seconds to wait for a block to be written to a connection before aborting the write.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_net_write_timeout for details.

Acceptable values are 1 to 1200, inclusive.
configSpec.
mysqlConfig_8_0.
groupConcatMaxLen		 integer (int64)

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_group_concat_max_len for details.

Acceptable values are 4 to 33554432, inclusive.
configSpec.
mysqlConfig_8_0.
tmpTableSize		 integer (int64)

The maximum size of internal in-memory temporary tables.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_tmp_table_size for details.

Acceptable values are 1024 to 536870912, inclusive.
configSpec.
mysqlConfig_8_0.
maxHeapTableSize		 integer (int64)

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_heap_table_size for details.

Acceptable values are 16384 to 536870912, inclusive.
configSpec.
mysqlConfig_8_0.
defaultTimeZone		 string

The servers default time zone.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-options.html#option_mysqld_default-time-zone for details.
configSpec.
mysqlConfig_8_0.
characterSetServer		 string

The servers default character set.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_character_set_server for details.
configSpec.
mysqlConfig_8_0.
collationServer		 string

The server default collation.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_collation_server for details.
configSpec.
mysqlConfig_8_0.
innodbAdaptiveHashIndex		 boolean (boolean)

Enables InnoDB adaptive hash index.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_adaptive_hash_index for details.
configSpec.
mysqlConfig_8_0.
innodbNumaInterleave		 boolean (boolean)

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_numa_interleave for details.
configSpec.
mysqlConfig_8_0.
innodbLogBufferSize		 integer (int64)

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_log_buffer_size for details.

Acceptable values are 1048576 to 268435456, inclusive.
configSpec.
mysqlConfig_8_0.
innodbLogFileSize		 integer (int64)

The size in bytes of the single InnoDB Redo log file.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_log_file_size for details.

Acceptable values are 268435456 to 4294967296, inclusive.
configSpec.
mysqlConfig_8_0.
innodbIoCapacity		 integer (int64)

Limits IO available for InnoDB background tasks.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_io_capacity for details.

Acceptable values are 100 to 100000, inclusive.
configSpec.
mysqlConfig_8_0.
innodbIoCapacityMax		 integer (int64)

Limits IO available for InnoDB background tasks.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_io_capacity_max for details.

Acceptable values are 100 to 100000, inclusive.
configSpec.
mysqlConfig_8_0.
innodbReadIoThreads		 integer (int64)

The number of I/O threads for read operations in InnoDB.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_read_io_threads for details.

Acceptable values are 1 to 16, inclusive.
configSpec.
mysqlConfig_8_0.
innodbWriteIoThreads		 integer (int64)

The number of I/O threads for write operations in InnoDB.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_write_io_threads for details.

Acceptable values are 1 to 16, inclusive.
configSpec.
mysqlConfig_8_0.
innodbPurgeThreads		 integer (int64)

The number of background threads devoted to the InnoDB purge operation.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_purge_threads for details.

Acceptable values are 1 to 16, inclusive.
configSpec.
mysqlConfig_8_0.
innodbThreadConcurrency		 integer (int64)

Defines the maximum number of threads permitted inside of InnoDB.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_thread_concurrency for details.

Acceptable values are 0 to 1000, inclusive.
configSpec.
mysqlConfig_8_0.
innodbTempDataFileMaxSize		 integer (int64)

Limits the max size of InnoDB temp tablespace.

See [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_temp_data_file_path for details.

Acceptable values are 0 to 107374182400, inclusive.
configSpec.
mysqlConfig_8_0.
threadCacheSize		 integer (int64)

How many threads the server should cache for reuse.

See MySQL documentation for details.

Acceptable values are 10 to 10000, inclusive.
configSpec.
mysqlConfig_8_0.
threadStack		 integer (int64)

The stack size for each thread. The default is large enough for normal operation.

See MySQL documentation for details.

Acceptable values are 131072 to 16777216, inclusive.
configSpec.
mysqlConfig_8_0.
joinBufferSize		 integer (int64)

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans.

See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.
configSpec.
mysqlConfig_8_0.
sortBufferSize		 integer (int64)

Each session that must perform a sort allocates a buffer of this size.

See MySQL documentation for details.

Acceptable values are 1024 to 16777216, inclusive.
configSpec.
mysqlConfig_8_0.
tableDefinitionCache		 integer (int64)

The number of table definitions that can be stored in the definition cache.

See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.
configSpec.
mysqlConfig_8_0.
tableOpenCache		 integer (int64)

The number of open tables for all threads.

See MySQL documentation for details.

Acceptable values are 400 to 524288, inclusive.
configSpec.
mysqlConfig_8_0.
tableOpenCacheInstances		 integer (int64)

The number of open tables cache instances.

See MySQL documentation for details.

Acceptable values are 1 to 32, inclusive.
configSpec.
mysqlConfig_8_0.
explicitDefaultsForTimestamp		 boolean (boolean)

Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
autoIncrementIncrement		 integer (int64)

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.
configSpec.
mysqlConfig_8_0.
autoIncrementOffset		 integer (int64)

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

Acceptable values are 1 to 65535, inclusive.
configSpec.
mysqlConfig_8_0.
syncBinlog		 integer (int64)

Controls how often the MySQL server synchronizes the binary log to disk.

See MySQL documentation for details.

Acceptable values are 0 to 4096, inclusive.
configSpec.
mysqlConfig_8_0.
binlogCacheSize		 integer (int64)

The size of the cache to hold changes to the binary log during a transaction.

See MySQL documentation for details.

Acceptable values are 4096 to 67108864, inclusive.
configSpec.
mysqlConfig_8_0.
binlogGroupCommitSyncDelay		 integer (int64)

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.

See MySQL documentation for details.

Acceptable values are 0 to 50000, inclusive.
configSpec.
mysqlConfig_8_0.
binlogRowImage		 string

For MySQL row-based replication, this variable determines how row images are written to the binary log.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
binlogRowsQueryLogEvents		 boolean (boolean)

When enabled, it causes the server to write informational log events such as row query log events into its binary log.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
rplSemiSyncMasterWaitForSlaveCount		 integer (int64)

The number of replica acknowledgments the source must receive per transaction before proceeding.

See MySQL documentation for details.

Acceptable values are 1 to 2, inclusive.
configSpec.
mysqlConfig_8_0.
slaveParallelType		 string

When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
slaveParallelWorkers		 integer (int64)

Sets the number of applier threads for executing replication transactions in parallel.

See MySQL documentation for details.

Acceptable values are 0 to 64, inclusive.
configSpec.
mysqlConfig_8_0.
regexpTimeLimit		 integer (int64)

The time limit for regular expression matching operations performed by REGEXP_LIKE and similar functions.

See MySQL documentation for details.

Acceptable values are 0 to 1048576, inclusive.
configSpec.
mysqlConfig_8_0.
mdbPreserveBinlogBytes		 integer (int64)

The size of the binary log to hold.

Acceptable values are 1073741824 to 1099511627776, inclusive.
configSpec.
mysqlConfig_8_0.
interactiveTimeout		 integer (int64)

The number of seconds the server waits for activity on an interactive connection before closing it.

See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.
configSpec.
mysqlConfig_8_0.
waitTimeout		 integer (int64)

The number of seconds the server waits for activity on a noninteractive connection before closing it.

See MySQL documentation for details.

Acceptable values are 600 to 86400, inclusive.
configSpec.
mysqlConfig_8_0.
mdbOfflineModeEnableLag		 integer (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

Acceptable values are 600 to 432000, inclusive.
configSpec.
mysqlConfig_8_0.
mdbOfflineModeDisableLag		 integer (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'. Should be less than mdb_offline_mode_enable_lag.

Acceptable values are 60 to 86400, inclusive.
configSpec.
mysqlConfig_8_0.
rangeOptimizerMaxMemSize		 integer (int64)

The limit on memory consumption for the range optimizer.

See MySQL documentation for details.

Acceptable values are 1048576 to 268435456, inclusive.
configSpec.
mysqlConfig_8_0.
slowQueryLog		 boolean (boolean)

Manages slow query log.

See MySQL documentation for details.
configSpec.
mysqlConfig_8_0.
slowQueryLogAlwaysWriteTime		 number (double)

Query execution time, after which query to be logged unconditionally, that is, log_slow_rate_limit will not apply to it.

See Percona documentation for details.
configSpec.
mysqlConfig_8_0.
logSlowRateType		 string

Specifies slow log granularity for log_slow_rate_limit QUERY or SESSION value.

See Percona documentation for details.
configSpec.
mysqlConfig_8_0.
logSlowRateLimit		 integer (int64)

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.

See Percona documentation for details.

Acceptable values are 1 to 1000, inclusive.
configSpec.
mysqlConfig_8_0.
logSlowSpStatements		 boolean (boolean)

When TRUE, statements executed by stored procedures are logged to the slow log.

See Percona documentation for details.
configSpec.
mysqlConfig_8_0.
logSlowFilter[]		 string

Filters the slow log by the query's execution plan.

See Percona documentation for details.
configSpec.
mysqlConfig_8_0.
mdbPriorityChoiceMaxLag		 integer (int64)

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from". Should be less than mdb_offline_mode_disable_lag.

Acceptable values are 0 to 86400, inclusive.
configSpec.
mysqlConfig_8_0.
innodbPageSize		 integer (int64)

Specifies the page size for InnoDB tablespaces.

For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 65536, inclusive.
configSpec.
mysqlConfig_8_0.
innodbOnlineAlterLogMaxSize		 integer (int64)

The limit in bytes on the size of the temporary log files used during online DDL operations

See MySQL documentation for the variable for details.

Acceptable values are 65536 to 107374182400, inclusive.
configSpec.
mysqlConfig_8_0.
innodbFtMinTokenSize		 integer (int64)

Minimum length of words that are stored in an InnoDB FULLTEXT index

See MySQL documentation for the variable for details.

Acceptable values are 0 to 16, inclusive.
configSpec.
mysqlConfig_8_0.
innodbFtMaxTokenSize		 integer (int64)

Maximum length of words that are stored in an InnoDB FULLTEXT index

See MySQL documentation for the variable for details.

Acceptable values are 10 to 84, inclusive.
configSpec.
mysqlConfig_8_0.
lowerCaseTableNames		 integer (int64)

Table names storage and comparison strategy

See MySQL documentation for the variable for details.

Acceptable values are 0 to 1, inclusive.
configSpec.
mysqlConfig_8_0.
maxSpRecursionDepth		 integer (int64)

The number of times that any given stored procedure may be called recursively.

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 255, inclusive.
configSpec.
mysqlConfig_8_0.
innodbCompressionLevel		 integer (int64)

The level of zlib compression to use for InnoDB compressed tables and indexes.

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 9, inclusive.
name string

New name of the cluster.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
maintenanceWindow object

Configuration of a maintenance window in an MySQL cluster.

Configuration of a maintenance window in a MySQL cluster.
maintenanceWindow.
anytime		 object
Maintenance operation can be scheduled anytime.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
maintenanceWindow.
weeklyMaintenanceWindow		 object
Maintenance operation can be scheduled on a weekly basis.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow

Weelky maintenance window settings.
maintenanceWindow.
weeklyMaintenanceWindow.
day		 string

Day of the week (in DDD format).
maintenanceWindow.
weeklyMaintenanceWindow.
hour		 string (int64)

Hour of the day in UTC (in HH format).

Acceptable values are 1 to 24, inclusive.
securityGroupIds[] string

New list of security group IDs to apply to the cluster.
deletionProtection boolean (boolean)

This option prevents unintended deletion of the cluster.

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.
Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье: