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

Method restore

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

Creates a new ClickHouse cluster using the specified backup.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters:restore

Body parameters

{
  "backupId": "string",
  "additionalBackupIds": [
    "string"
  ],
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "version": "string",
    "clickhouse": {
      "config": {
        "logLevel": "string",
        "mergeTree": {
          "replicatedDeduplicationWindow": "integer",
          "replicatedDeduplicationWindowSeconds": "integer",
          "partsToDelayInsert": "integer",
          "partsToThrowInsert": "integer",
          "maxReplicatedMergesInQueue": "integer",
          "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
          "maxBytesToMergeAtMinSpaceInPool": "integer",
          "maxBytesToMergeAtMaxSpaceInPool": "integer"
        },
        "compression": [
          {
            "method": "string",
            "minPartSize": "string",
            "minPartSizeRatio": "number"
          }
        ],
        "dictionaries": [
          {
            "name": "string",
            "structure": {
              "id": {
                "name": "string"
              },
              "key": {
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "rangeMin": {
                "name": "string",
                "type": "string",
                "nullValue": "string",
                "expression": "string",
                "hierarchical": true,
                "injective": true
              },
              "rangeMax": {
                "name": "string",
                "type": "string",
                "nullValue": "string",
                "expression": "string",
                "hierarchical": true,
                "injective": true
              },
              "attributes": [
                {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                }
              ]
            },
            "layout": {
              "type": "string",
              "sizeInCells": "string"
            },

            // `configSpec.clickhouse.config.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
            "fixedLifetime": "string",
            "lifetimeRange": {
              "min": "string",
              "max": "string"
            },
            // end of the list of possible fields`configSpec.clickhouse.config.dictionaries[]`

            "httpSource": {
              "url": "string",
              "format": "string"
            },
            "mysqlSource": {
              "db": "string",
              "table": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "replicas": [
                {
                  "host": "string",
                  "priority": "string",
                  "port": "string",
                  "user": "string",
                  "password": "string"
                }
              ],
              "where": "string",
              "invalidateQuery": "string"
            },
            "clickhouseSource": {
              "db": "string",
              "table": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "where": "string"
            },
            "mongodbSource": {
              "db": "string",
              "collection": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string"
            },
            "postgresqlSource": {
              "db": "string",
              "table": "string",
              "hosts": [
                "string"
              ],
              "port": "string",
              "user": "string",
              "password": "string",
              "invalidateQuery": "string",
              "sslMode": "string"
            }
          }
        ],
        "graphiteRollup": [
          {
            "name": "string",
            "patterns": [
              {
                "regexp": "string",
                "function": "string",
                "retention": [
                  {
                    "age": "string",
                    "precision": "string"
                  }
                ]
              }
            ]
          }
        ],
        "kafka": {
          "securityProtocol": "string",
          "saslMechanism": "string",
          "saslUsername": "string",
          "saslPassword": "string"
        },
        "kafkaTopics": [
          {
            "name": "string",
            "settings": {
              "securityProtocol": "string",
              "saslMechanism": "string",
              "saslUsername": "string",
              "saslPassword": "string"
            }
          }
        ],
        "rabbitmq": {
          "username": "string",
          "password": "string"
        },
        "maxConnections": "integer",
        "maxConcurrentQueries": "integer",
        "keepAliveTimeout": "integer",
        "uncompressedCacheSize": "integer",
        "markCacheSize": "integer",
        "maxTableSizeToDrop": "integer",
        "maxPartitionSizeToDrop": "integer",
        "builtinDictionariesReloadInterval": "integer",
        "timezone": "string",
        "geobaseUri": "string",
        "queryLogRetentionSize": "integer",
        "queryLogRetentionTime": "integer",
        "queryThreadLogEnabled": true,
        "queryThreadLogRetentionSize": "integer",
        "queryThreadLogRetentionTime": "integer",
        "partLogRetentionSize": "integer",
        "partLogRetentionTime": "integer",
        "metricLogEnabled": true,
        "metricLogRetentionSize": "integer",
        "metricLogRetentionTime": "integer",
        "traceLogEnabled": true,
        "traceLogRetentionSize": "integer",
        "traceLogRetentionTime": "integer",
        "textLogEnabled": true,
        "textLogRetentionSize": "integer",
        "textLogRetentionTime": "integer",
        "textLogLevel": "string",
        "backgroundPoolSize": "integer",
        "backgroundSchedulePoolSize": "integer"
      },
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "zookeeper": {
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true,
      "webSql": true,
      "metrika": true,
      "serverless": true,
      "dataTransfer": true,
      "yandexQuery": true
    },
    "cloudStorage": {
      "enabled": true
    },
    "sqlDatabaseManagement": true,
    "sqlUserManagement": true,
    "adminPassword": "string",
    "embeddedKeeper": true
  },
  "hostSpecs": [
    {
      "zoneId": "string",
      "type": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "shardName": "string"
    }
  ],
  "networkId": "string",
  "folderId": "string",
  "serviceAccountId": "string",
  "securityGroupIds": [
    "string"
  ]
}
Field Description
backupId string

Required. ID of the backup to restore from. This backup will be used to create one cluster shard. To get the backup ID, use a listBackups request.
additionalBackupIds[] string

Additional IDs of the backups to restore from. Each additional backup is responsible for restoring separate shard. Restored cluster will have len(additional_backup_ids)+1 shards in total. To get the backup ID, use a listBackups request.
name string

Required. Name of the new ClickHouse cluster. The name must be unique within the folder.

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

Description of the new ClickHouse cluster.

The maximum string length in characters is 256.
labels object

Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary".

No more than 64 per resource. The maximum string length in characters for each key is 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]*.
environment string

Required. Deployment environment of the new ClickHouse cluster.

  • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
  • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
configSpec object

Required. Configuration for the ClickHouse cluster to be created.
configSpec.
version		 string

Version of the ClickHouse server software.
configSpec.
clickhouse		 object

Configuration and resources for a ClickHouse server.
configSpec.
clickhouse.
config		 object

Configuration for a ClickHouse server.

ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation.

Any options not listed here are not supported.
configSpec.
clickhouse.
config.
logLevel		 string

Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.
configSpec.
clickhouse.
config.
mergeTree		 object

Settings for the MergeTree engine. See description in ClickHouse documentation.

Options specific to the MergeTree table engine.
configSpec.
clickhouse.
config.
mergeTree.
replicatedDeduplicationWindow		 integer (int64)

Number of blocks of hashes to keep in ZooKeeper.
configSpec.
clickhouse.
config.
mergeTree.
replicatedDeduplicationWindowSeconds		 integer (int64)

Period of time to keep blocks of hashes for.
configSpec.
clickhouse.
config.
mergeTree.
partsToDelayInsert		 integer (int64)

If table contains at least that many active parts in single partition, artificially slow down insert into table.
configSpec.
clickhouse.
config.
mergeTree.
partsToThrowInsert		 integer (int64)

If more than this number active parts in single partition, throw 'Too many parts ...' exception.
configSpec.
clickhouse.
config.
mergeTree.
maxReplicatedMergesInQueue		 integer (int64)

How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue.
configSpec.
clickhouse.
config.
mergeTree.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge		 integer (int64)

If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process.
configSpec.
clickhouse.
config.
mergeTree.
maxBytesToMergeAtMinSpaceInPool		 integer (int64)

Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue).
configSpec.
clickhouse.
config.
mergeTree.
maxBytesToMergeAtMaxSpaceInPool		 integer (int64)
configSpec.
clickhouse.
config.
compression[]		 object

Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation.
configSpec.
clickhouse.
config.
compression[].
method		 string

Compression method to use for the specified combination of min_part_size and min_part_size_ratio.
configSpec.
clickhouse.
config.
compression[].
minPartSize		 string (int64)

Minimum size of a part of a table.

The minimum value is 1.
configSpec.
clickhouse.
config.
compression[].
minPartSizeRatio		 number (double)

Minimum ratio of a part relative to the size of all the data in the table.
configSpec.
clickhouse.
config.
dictionaries[]		 object

Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation.
configSpec.
clickhouse.
config.
dictionaries[].
name		 string

Required. Name of the external dictionary.
configSpec.
clickhouse.
config.
dictionaries[].
structure		 object
Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
id		 object

Single numeric key column for the dictionary.

Numeric key.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
id.
name		 string

Required. Name of the numeric key.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
key		 object

Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.

Complex key.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[]		 object

Required. Attributes of a complex key.

Must contain at least one element.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
name		 string

Required. Name of the column.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
type		 string

Required. Type of the column.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
nullValue		 string

Default value for an element without data (for example, an empty string).
configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
expression		 string

Expression, describing the attribute, if applicable.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
hierarchical		 boolean (boolean)

Indication of hierarchy support. Default value: false.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
key.
attributes[].
injective		 boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin		 object

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
name		 string

Required. Name of the column.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
type		 string

Required. Type of the column.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
nullValue		 string

Default value for an element without data (for example, an empty string).
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
expression		 string

Expression, describing the attribute, if applicable.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
hierarchical		 boolean (boolean)

Indication of hierarchy support. Default value: false.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMin.
injective		 boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax		 object

Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
name		 string

Required. Name of the column.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
type		 string

Required. Type of the column.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
nullValue		 string

Default value for an element without data (for example, an empty string).
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
expression		 string

Expression, describing the attribute, if applicable.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
hierarchical		 boolean (boolean)

Indication of hierarchy support. Default value: false.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
rangeMax.
injective		 boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[]		 object

Required. Description of the fields available for database queries. For details, see ClickHouse documentation.

Must contain at least one element.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
name		 string

Required. Name of the column.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
type		 string

Required. Type of the column.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
nullValue		 string

Default value for an element without data (for example, an empty string).
configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
expression		 string

Expression, describing the attribute, if applicable.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
hierarchical		 boolean (boolean)

Indication of hierarchy support. Default value: false.
configSpec.
clickhouse.
config.
dictionaries[].
structure.
attributes[].
injective		 boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.
configSpec.
clickhouse.
config.
dictionaries[].
layout		 object
Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation.

Layout determining how to store the dictionary in memory.
configSpec.
clickhouse.
config.
dictionaries[].
layout.
type		 string

Required. Layout type for an external dictionary.

  • FLAT: The entire dictionary is stored in memory in the form of flat arrays. Available for all dictionary sources.
  • HASHED: The entire dictionary is stored in memory in the form of a hash table. Available for all dictionary sources.
  • COMPLEX_KEY_HASHED: Similar to HASHED, to be used with composite keys. Available for all dictionary sources.
  • RANGE_HASHED: The entire dictionary is stored in memory in the form of a hash table, with an ordered array of ranges and their corresponding values. Available for all dictionary sources.
  • CACHE: The dictionary is stored in a cache with a set number of cells. Available for MySQL, ClickHouse and HTTP dictionary sources.
  • COMPLEX_KEY_CACHE: Similar to CACHE, to be used with composite keys. Available for MySQL, ClickHouse and HTTP dictionary sources.
configSpec.
clickhouse.
config.
dictionaries[].
layout.
sizeInCells		 string (int64)

Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.
configSpec.
clickhouse.
config.
dictionaries[].
fixedLifetime		 string (int64)
configSpec.clickhouse.config.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange

Fixed interval between dictionary updates.
configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange		 object
Range of intervals between dictionary updates for ClickHouse to choose from.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange
configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange.
min		 string (int64)

Minimum dictionary lifetime.
configSpec.
clickhouse.
config.
dictionaries[].
lifetimeRange.
max		 string (int64)

Maximum dictionary lifetime.
configSpec.
clickhouse.
config.
dictionaries[].
httpSource		 object
HTTP source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
httpSource.
url		 string

Required. URL of the source dictionary available over HTTP.
configSpec.
clickhouse.
config.
dictionaries[].
httpSource.
format		 string

Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource		 object
MySQL source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
db		 string

Required. Name of the MySQL database to connect to.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
table		 string

Required. Name of the database table to use as a ClickHouse dictionary.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
port		 string (int64)

Default port to use when connecting to a replica of the dictionary source.

Acceptable values are 0 to 65535, inclusive.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
user		 string

Name of the default user for replicas of the dictionary source.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
password		 string

Password of the default user for replicas of the dictionary source.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[]		 object

Required. List of MySQL replicas of the database used as dictionary source.

Must contain at least one element.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
host		 string

Required. MySQL host of the replica.

The maximum string length in characters is 253.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
priority		 string (int64)

Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number.

Value must be greater than 0.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
port		 string (int64)

Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source.

Acceptable values are 0 to 65535, inclusive.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
user		 string

Name of the MySQL database user.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
replicas[].
password		 string

Password of the MySQL database user.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
where		 string

Selection criteria for the data in the specified MySQL table.
configSpec.
clickhouse.
config.
dictionaries[].
mysqlSource.
invalidateQuery		 string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource		 object
ClickHouse source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
db		 string

Required. Name of the ClickHouse database.
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
table		 string

Required. Name of the table in the specified database to be used as the dictionary source.
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
host		 string

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
port		 string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
user		 string

Required. Name of the ClickHouse database user.
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
password		 string

Password of the ClickHouse database user.
configSpec.
clickhouse.
config.
dictionaries[].
clickhouseSource.
where		 string

Selection criteria for the data in the specified ClickHouse table.
configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource		 object
MongoDB source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
db		 string

Required. Name of the MongoDB database.
configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
collection		 string

Required. Name of the collection in the specified database to be used as the dictionary source.
configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
host		 string

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.
configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
port		 string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.
configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
user		 string

Required. Name of the MongoDB database user.
configSpec.
clickhouse.
config.
dictionaries[].
mongodbSource.
password		 string

Password of the MongoDB database user.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource		 object
PostgreSQL source for the dictionary.
configSpec.clickhouse.config.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
db		 string

Required. Name of the PostrgreSQL database.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
table		 string

Required. Name of the table in the specified database to be used as the dictionary source.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
hosts[]		 string

Required. Name of the PostrgreSQL host

Must contain at least one element.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
port		 string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
user		 string

Required. Name of the PostrgreSQL database user.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
password		 string

Password of the PostrgreSQL database user.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
invalidateQuery		 string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
sslMode		 string

Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.

  • DISABLE: Only try a non-SSL connection.
  • ALLOW: First try a non-SSL connection; if that fails, try an SSL connection.
  • PREFER: First try an SSL connection; if that fails, try a non-SSL connection.
  • VERIFY_CA: Only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA).
  • VERIFY_FULL: Only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the requested server host name matches that in the certificate.
configSpec.
clickhouse.
config.
graphiteRollup[]		 object

Rollup settings for the GraphiteMergeTree table engine.
configSpec.
clickhouse.
config.
graphiteRollup[].
name		 string

Required. Name for the specified combination of settings for Graphite rollup.
configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[]		 object

Required. Pattern to use for the rollup.

Must contain at least one element.
configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
regexp		 string

Pattern for metric names.
configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
function		 string

Required. Name of the aggregating function to apply to data of the age specified in retention.
configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[]		 object

Required. Age of data to use for thinning.

Must contain at least one element.
configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[].
age		 string (int64)

Minimum age of the data in seconds.

Value must be greater than 0.
configSpec.
clickhouse.
config.
graphiteRollup[].
patterns[].
retention[].
precision		 string (int64)

Precision of determining the age of the data, in seconds.

Value must be greater than 0.
configSpec.
clickhouse.
config.
kafka		 object
configSpec.
clickhouse.
config.
kafka.
securityProtocol		 string
configSpec.
clickhouse.
config.
kafka.
saslMechanism		 string
configSpec.
clickhouse.
config.
kafka.
saslUsername		 string
configSpec.
clickhouse.
config.
kafka.
saslPassword		 string
configSpec.
clickhouse.
config.
kafkaTopics[]		 object
configSpec.
clickhouse.
config.
kafkaTopics[].
name		 string

Required.
configSpec.
clickhouse.
config.
kafkaTopics[].
settings		 object

Required.
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
securityProtocol		 string
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
saslMechanism		 string
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
saslUsername		 string
configSpec.
clickhouse.
config.
kafkaTopics[].
settings.
saslPassword		 string
configSpec.
clickhouse.
config.
rabbitmq		 object
configSpec.
clickhouse.
config.
rabbitmq.
username		 string
configSpec.
clickhouse.
config.
rabbitmq.
password		 string
configSpec.
clickhouse.
config.
maxConnections		 integer (int64)

Maximum number of inbound connections.

The minimum value is 10.
configSpec.
clickhouse.
config.
maxConcurrentQueries		 integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.
configSpec.
clickhouse.
config.
keepAliveTimeout		 integer (int64)

Number of milliseconds that ClickHouse waits for incoming requests before closing the connection.
configSpec.
clickhouse.
config.
uncompressedCacheSize		 integer (int64)

Cache size (in bytes) for uncompressed data used by MergeTree tables.
configSpec.
clickhouse.
config.
markCacheSize		 integer (int64)

Approximate size (in bytes) of the cache of "marks" used by MergeTree tables.

Value must be greater than 0.
configSpec.
clickhouse.
config.
maxTableSizeToDrop		 integer (int64)

Maximum size of the table that can be deleted using a DROP query.
configSpec.
clickhouse.
config.
maxPartitionSizeToDrop		 integer (int64)

Maximum size of the partition that can be deleted using a DROP query.
configSpec.
clickhouse.
config.
builtinDictionariesReloadInterval		 integer (int64)

The setting is deprecated and has no effect.
configSpec.
clickhouse.
config.
timezone		 string

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier.
configSpec.
clickhouse.
config.
geobaseUri		 string

Address of the archive with the user geobase in Object Storage.
configSpec.
clickhouse.
config.
queryLogRetentionSize		 integer (int64)

The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled.
configSpec.
clickhouse.
config.
queryLogRetentionTime		 integer (int64)

The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled.
configSpec.
clickhouse.
config.
queryThreadLogEnabled		 boolean (boolean)

Whether query_thread_log system table is enabled.
configSpec.
clickhouse.
config.
queryThreadLogRetentionSize		 integer (int64)

The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled.
configSpec.
clickhouse.
config.
queryThreadLogRetentionTime		 integer (int64)

The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled.
configSpec.
clickhouse.
config.
partLogRetentionSize		 integer (int64)

The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled.
configSpec.
clickhouse.
config.
partLogRetentionTime		 integer (int64)

The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled.
configSpec.
clickhouse.
config.
metricLogEnabled		 boolean (boolean)

Whether metric_log system table is enabled.
configSpec.
clickhouse.
config.
metricLogRetentionSize		 integer (int64)

The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled.
configSpec.
clickhouse.
config.
metricLogRetentionTime		 integer (int64)

The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled.
configSpec.
clickhouse.
config.
traceLogEnabled		 boolean (boolean)

Whether trace_log system table is enabled.
configSpec.
clickhouse.
config.
traceLogRetentionSize		 integer (int64)

The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled.
configSpec.
clickhouse.
config.
traceLogRetentionTime		 integer (int64)

The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled.
configSpec.
clickhouse.
config.
textLogEnabled		 boolean (boolean)

Whether text_log system table is enabled.
configSpec.
clickhouse.
config.
textLogRetentionSize		 integer (int64)

The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled.
configSpec.
clickhouse.
config.
textLogRetentionTime		 integer (int64)

The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled.
configSpec.
clickhouse.
config.
textLogLevel		 string

Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.
configSpec.
clickhouse.
config.
backgroundPoolSize		 integer (int64)

Value must be greater than 0.
configSpec.
clickhouse.
config.
backgroundSchedulePoolSize		 integer (int64)

Value must be greater than 0.
configSpec.
clickhouse.
resources		 object

Resources allocated to ClickHouse hosts.
configSpec.
clickhouse.
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.
clickhouse.
resources.
diskSize		 string (int64)

Volume of the storage available to a host, in bytes.
configSpec.
clickhouse.
resources.
diskTypeId		 string

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
configSpec.
zookeeper		 object

Configuration and resources for a ZooKeeper server.
configSpec.
zookeeper.
resources		 object

Resources allocated to ZooKeeper hosts. If not set, minimal available resources will be used. All available resource presets can be retrieved with a list request.
configSpec.
zookeeper.
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.
zookeeper.
resources.
diskSize		 string (int64)

Volume of the storage available to a host, in bytes.
configSpec.
zookeeper.
resources.
diskTypeId		 string

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • 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.
access		 object

Access policy for external services.

If you want a specific service to access the ClickHouse cluster, then set the necessary values in this policy.
configSpec.
access.
dataLens		 boolean (boolean)

Allow to export data from the cluster to DataLens.
configSpec.
access.
webSql		 boolean (boolean)

Allow SQL queries to the cluster databases from the management console.

See SQL queries in the management console for more details.
configSpec.
access.
metrika		 boolean (boolean)

Allow to import data from Yandex Metrica and AppMetrica to the cluster.

See AppMetrica documentation for more details.
configSpec.
access.
serverless		 boolean (boolean)

Allow access to cluster for Serverless.
configSpec.
access.
dataTransfer		 boolean (boolean)

Allow access for DataTransfer
configSpec.
access.
yandexQuery		 boolean (boolean)

Allow access for Query
configSpec.
cloudStorage		 object
configSpec.
cloudStorage.
enabled		 boolean (boolean)

Whether to use Object Storage for storing ClickHouse data.
configSpec.
sqlDatabaseManagement		 boolean (boolean)

Whether database management through SQL commands is enabled.
configSpec.
sqlUserManagement		 boolean (boolean)

Whether user management through SQL commands is enabled.
configSpec.
adminPassword		 string

Password for user 'admin' that has SQL user management access.
configSpec.
embeddedKeeper		 boolean (boolean)

Whether cluster should use embedded Keeper instead of Zookeeper
hostSpecs[] object

Required. Configurations for ClickHouse hosts that should be created for the cluster that is being created from the backup.

Must contain at least one element.
hostSpecs[].
zoneId		 string

ID of the availability zone where the host resides. To get a list of available zones, use the list request.

The maximum string length in characters is 50.
hostSpecs[].
type		 string

Required. Type of the host to be deployed.

  • CLICKHOUSE: ClickHouse host.
  • ZOOKEEPER: ZooKeeper host.
hostSpecs[].
subnetId		 string

ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.networkId field.

The maximum string length in characters is 50.
hostSpecs[].
assignPublicIp		 boolean (boolean)

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assignPublicIp set as needed.

Possible values:

  • false - don't assign a public IP to the host.
  • true - the host should have a public IP address.
hostSpecs[].
shardName		 string

Name of the shard that the host is assigned to.

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

Required. ID of the network to create the ClickHouse cluster in.

The maximum string length in characters is 50.
folderId string

ID of the folder to create the ClickHouse cluster in.

The maximum string length in characters is 50.
serviceAccountId string

ID of the service account used for access to Object Storage.
securityGroupIds[] string

User security groups

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