Метод get

Возвращает указанный ресурс User для ClickHouse.

Чтобы получить список доступных ресурсов User для ClickHouse, отправьте запрос list.

HTTP-запрос

GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/users/{userName}

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера ClickHouse, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.
userName Обязательное поле. Имя запрашиваемого ресурса User для ClickHouse. Чтобы получить имя пользователя, используйте запрос list. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.

Ответ

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string",
  "permissions": [
    {
      "databaseName": "string"
    }
  ],
  "settings": {
    "readonly": "integer",
    "allowDdl": true,
    "insertQuorum": "integer",
    "connectTimeout": "integer",
    "receiveTimeout": "integer",
    "sendTimeout": "integer",
    "insertQuorumTimeout": "integer",
    "selectSequentialConsistency": true,
    "maxReplicaDelayForDistributedQueries": "integer",
    "fallbackToStaleReplicasForDistributedQueries": true,
    "replicationAlterPartitionsSync": "integer",
    "distributedProductMode": "string",
    "distributedAggregationMemoryEfficient": true,
    "distributedDdlTaskTimeout": "integer",
    "compile": true,
    "minCountToCompile": "integer",
    "compileExpressions": true,
    "minCountToCompileExpression": "integer",
    "maxBlockSize": "integer",
    "minInsertBlockSizeRows": "integer",
    "minInsertBlockSizeBytes": "integer",
    "maxInsertBlockSize": "integer",
    "minBytesToUseDirectIo": "integer",
    "useUncompressedCache": true,
    "mergeTreeMaxRowsToUseCache": "integer",
    "mergeTreeMaxBytesToUseCache": "integer",
    "mergeTreeMinRowsForConcurrentRead": "integer",
    "mergeTreeMinBytesForConcurrentRead": "integer",
    "maxBytesBeforeExternalGroupBy": "integer",
    "maxBytesBeforeExternalSort": "integer",
    "groupByTwoLevelThreshold": "integer",
    "groupByTwoLevelThresholdBytes": "integer",
    "priority": "integer",
    "maxThreads": "integer",
    "maxMemoryUsage": "integer",
    "maxMemoryUsageForUser": "integer",
    "maxNetworkBandwidth": "integer",
    "maxNetworkBandwidthForUser": "integer",
    "forceIndexByDate": true,
    "forcePrimaryKey": true,
    "maxRowsToRead": "integer",
    "maxBytesToRead": "integer",
    "readOverflowMode": "string",
    "maxRowsToGroupBy": "integer",
    "groupByOverflowMode": "string",
    "maxRowsToSort": "integer",
    "maxBytesToSort": "integer",
    "sortOverflowMode": "string",
    "maxResultRows": "integer",
    "maxResultBytes": "integer",
    "resultOverflowMode": "string",
    "maxRowsInDistinct": "integer",
    "maxBytesInDistinct": "integer",
    "distinctOverflowMode": "string",
    "maxRowsToTransfer": "integer",
    "maxBytesToTransfer": "integer",
    "transferOverflowMode": "string",
    "maxExecutionTime": "integer",
    "timeoutOverflowMode": "string",
    "maxColumnsToRead": "integer",
    "maxTemporaryColumns": "integer",
    "maxTemporaryNonConstColumns": "integer",
    "maxQuerySize": "integer",
    "maxAstDepth": "integer",
    "maxAstElements": "integer",
    "maxExpandedAstElements": "integer",
    "inputFormatValuesInterpretExpressions": true,
    "inputFormatDefaultsForOmittedFields": true,
    "outputFormatJsonQuote_64BitIntegers": true,
    "outputFormatJsonQuoteDenormals": true,
    "lowCardinalityAllowInNativeFormat": true,
    "emptyResultForAggregationByEmptySet": true,
    "httpConnectionTimeout": "integer",
    "httpReceiveTimeout": "integer",
    "httpSendTimeout": "integer",
    "enableHttpCompression": true,
    "sendProgressInHttpHeaders": true,
    "httpHeadersProgressInterval": "integer",
    "addHttpCorsHeader": true
  },
  "quotas": [
    {
      "intervalDuration": "integer",
      "queries": "integer",
      "errors": "integer",
      "resultRows": "integer",
      "readRows": "integer",
      "executionTime": "integer"
    }
  ]
}

Ресурс User для ClickHouse. Подробнее см. в разделе Developer's guide.

Поле Описание
name string

Имя пользователя базы данных ClickHouse.

clusterId string

Идентификатор кластера ClickHouse, к которому принадлежит пользователь.

permissions[] object

Набор разрешений, предоставленных пользователю.

permissions[].
databaseName
string

Имя базы данных, к которой предоставляет доступ разрешение.

settings object

Пользовательские настройки ClickHouse. Поддерживаемые параметры входят в число параметров, описанных в разделе документации ClickHouse.

settings.
readonly
integer (int64)

Ограничивает разрешения для запросов, не относящихся к DDL. Возможные значения:

  • 0 (по умолчанию) - никаких ограничений.
  • 1-разрешены только запросы на чтение данных.
  • 2 — разрешены запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse.

Допустимые значения — от 0 до 2 включительно.

settings.
allowDdl
boolean (boolean)

Разрешены ли запросы DDL. Значение по умолчанию "false". См. подробное описание в документации ClickHouse.

settings.
insertQuorum
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
connectTimeout
integer (int64)

Время ожидания соединения в миллисекундах. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
receiveTimeout
integer (int64)

Время ожидания приема в миллисекундах. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
sendTimeout
integer (int64)

Время ожидания отправки в миллисекундах. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
insertQuorumTimeout
integer (int64)

Время ожидания записи для кворума в миллисекундах. Значение по умолчанию: 60000. См. подробное описание в документации ClickHouse.

Минимальное значение — 1000.

settings.
selectSequentialConsistency
boolean (boolean)

См. подробное описание в документации ClickHouse.

settings.
maxReplicaDelayForDistributedQueries
integer (int64)

Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, реплика перестает использоваться. Значение по умолчанию: 300000. См. подробное описание в документации ClickHouse.

Минимальное значение — 1000.

settings.
fallbackToStaleReplicasForDistributedQueries
boolean (boolean)

См. подробное описание в документации ClickHouse.

settings.
replicationAlterPartitionsSync
integer (int64)

См. подробное описание в документации ClickHouse.

Допустимые значения — от 0 до 2 включительно.

settings.
distributedProductMode
string

См. подробное описание в документации ClickHouse.

  • DISTRIBUTED_PRODUCT_MODE_DENY: Значение по умолчанию. Запрещает использование этих типов подзапросов (возвращает исключение "Double-distributed in/JOIN subqueries is denied").
  • DISTRIBUTED_PRODUCT_MODE_LOCAL: Заменяет базу данных и таблицу в подзапросе локальными для конечного сервера (шарда), оставляя обычный IN / JOIN.
  • DISTRIBUTED_PRODUCT_MODE_GLOBAL: Заменяет IN/JOIN запрос на GLOBAL IN/GLOBAL JOIN.
  • DISTRIBUTED_PRODUCT_MODE_ALLOW: Позволяет использовать эти типы подзапросов.
settings.
distributedAggregationMemoryEfficient
boolean (boolean)

Включен ли режим экономии памяти распределенной агрегации.

settings.
distributedDdlTaskTimeout
integer (int64)

Время ожидания запросов DDL в миллисекундах.

settings.
compile
boolean (boolean)

Включена ли компиляция запросов. См. подробное описание в документации ClickHouse.

settings.
minCountToCompile
integer (int64)

Число структурно идентичных запросов до их компиляции. См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
compileExpressions
boolean (boolean)

Включена ли компиляция выражений.

settings.
minCountToCompileExpression
integer (int64)

Число идентичных выражений до их компиляции.

Минимальное значение — 0.

settings.
maxBlockSize
integer (int64)

См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
minInsertBlockSizeRows
integer (int64)

Минимальный размер блока в строках при выполнении INSERT запросов. Блоки меньшего размера ClickHouse будет склеивать в один блок. Если установлено значение "0", ClichHouse не будет склеивать блоки.

Минимальное значение — 0.

settings.
minInsertBlockSizeBytes
integer (int64)

Минимальный размер блока в байтах при выполнении INSERT запросов. Блоки меньшего размера ClickHouse будет склеивать в один блок. Если установлено значение "0", ClichHouse не будет склеивать блоки.

Минимальное значение — 0.

settings.
maxInsertBlockSize
integer (int64)

См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
minBytesToUseDirectIo
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
useUncompressedCache
boolean (boolean)

См. подробное описание в документации ClickHouse.

settings.
mergeTreeMaxRowsToUseCache
integer (int64)

Максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанное значение. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
mergeTreeMaxBytesToUseCache
integer (int64)

Максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанное значение.

Значение должно быть больше 0.

settings.
mergeTreeMinRowsForConcurrentRead
integer (int64)

Минимальное число строк, считываемых из файла для одновременного чтения. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
mergeTreeMinBytesForConcurrentRead
integer (int64)

Минимальное число байтов, считываемых из файла для одновременного чтения.

Значение должно быть больше 0.

settings.
maxBytesBeforeExternalGroupBy
integer (int64)
settings.
maxBytesBeforeExternalSort
integer (int64)
settings.
groupByTwoLevelThreshold
integer (int64)
settings.
groupByTwoLevelThresholdBytes
integer (int64)
settings.
priority
integer (int64)

Приоритет запроса.

Минимальное значение — 0.

settings.
maxThreads
integer (int64)

См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
maxMemoryUsage
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxMemoryUsageForUser
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxNetworkBandwidth
integer (int64)

См. подробное описание в документации ClickHouse.

settings.
maxNetworkBandwidthForUser
integer (int64)

См. подробное описание в документации ClickHouse.

settings.
forceIndexByDate
boolean (boolean)

См. подробное описание в документации ClickHouse.

settings.
forcePrimaryKey
boolean (boolean)

См. подробное описание в документации ClickHouse.

settings.
maxRowsToRead
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxBytesToRead
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
readOverflowMode
string

См. подробное описание в документации ClickHouse.

settings.
maxRowsToGroupBy
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
groupByOverflowMode
string

См. подробное описание в документации ClickHouse.

settings.
maxRowsToSort
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxBytesToSort
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
sortOverflowMode
string

См. подробное описание в документации ClickHouse.

settings.
maxResultRows
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxResultBytes
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
resultOverflowMode
string

См. подробное описание в документации ClickHouse.

settings.
maxRowsInDistinct
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxBytesInDistinct
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
distinctOverflowMode
string

См. подробное описание в документации ClickHouse.

settings.
maxRowsToTransfer
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxBytesToTransfer
integer (int64)

См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
transferOverflowMode
string

См. подробное описание в документации ClickHouse.

settings.
maxExecutionTime
integer (int64)

Максимальное время выполнения запроса в миллисекундах. См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
timeoutOverflowMode
string

См. подробное описание в документации ClickHouse.

settings.
maxColumnsToRead
integer (int64)

Максимальное количество столбцов, которые можно прочитать из таблицы в одном запросе. См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxTemporaryColumns
integer (int64)

Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, включая постоянные столбцы. См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxTemporaryNonConstColumns
integer (int64)

Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, за исключением постоянных столбцов. См. подробное описание в документации ClickHouse.

Минимальное значение — 0.

settings.
maxQuerySize
integer (int64)

Наибольшая часть запроса, которая может быть передана в RAM для разбора с помощью анализатора SQL, в байтах. Значение по умолчанию: 262144. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
maxAstDepth
integer (int64)

Максимальная глубина синтаксического дерева запроса. Значение по умолчанию: 1000. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
maxAstElements
integer (int64)

Максимальный размер синтаксического дерева запроса в количестве узлов. Значение по умолчанию: 50000. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.

settings.
maxExpandedAstElements
integer (int64)

Максимальный размер синтаксического дерева запроса в количестве узлов после раскрытия псевдонимов и звездочки. Значение по умолчанию: 500000.

Значение должно быть больше 0.

settings.
inputFormatValuesInterpretExpressions
boolean (boolean)

См. подробное описание в документации ClickHouse.

settings.
inputFormatDefaultsForOmittedFields
boolean (boolean)

См. подробное описание в документации ClickHouse.

settings.
outputFormatJsonQuote_64BitIntegers
boolean (boolean)

Если значение истинно, то при использовании JSON форматов UInt64 и Int64 числа выводятся в кавычках. См. подробное описание в документации ClickHouse.

settings.
outputFormatJsonQuoteDenormals
boolean (boolean)

Включен ли вывод специальных значений с плавающей запятой ( "+nan", "-nan", "+inf" и "-inf") в формате вывода JSON.

settings.
lowCardinalityAllowInNativeFormat
boolean (boolean)
settings.
emptyResultForAggregationByEmptySet
boolean (boolean)
settings.
httpConnectionTimeout
integer (int64)

Время ожидания соединения в миллисекундах.

settings.
httpReceiveTimeout
integer (int64)

Время ожидания приема в миллисекундах.

settings.
httpSendTimeout
integer (int64)

Время ожидания отправки в миллисекундах.

settings.
enableHttpCompression
boolean (boolean)

См. подробное описание в документации ClickHouse.

settings.
sendProgressInHttpHeaders
boolean (boolean)

Включены ли уведомления о ходе выполнения с использованием заголовков X-ClickHouse-Progress. Значение по умолчанию "false". См. подробное описание в документации ClickHouse.

settings.
httpHeadersProgressInterval
integer (int64)

Минимальный интервал между уведомлениями о ходе выполнения, в миллисекундах. Значение по умолчанию: 100.

settings.
addHttpCorsHeader
boolean (boolean)

Включен ли заголовок CORS в HTTP-ответах. Значение по умолчанию "false".

quotas[] object

Представление квот ClickHouse. Каждая квота связана с пользователем и ограничивает использование ресурсов на определенный интервал. См. подробное описание в документации ClickHouse.

quotas[].
intervalDuration
integer (int64)

Длительность интервала для квоты в миллисекундах. Минимальное значение - 1 минута.

Минимальное значение — 60000.

quotas[].
queries
integer (int64)

Общее количество запросов. 0-неограниченно.

Минимальное значение — 0.

quotas[].
errors
integer (int64)

Количество запросов, которые вызвали исключение. 0-неограниченно.

Минимальное значение — 0.

quotas[].
resultRows
integer (int64)

Общее число строк, приведенных в результате. 0-неограниченно.

Минимальное значение — 0.

quotas[].
readRows
integer (int64)

Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно.

Минимальное значение — 0.

quotas[].
executionTime
integer (int64)

Общее время выполнения запроса, в миллисекундах. 0-неограниченно.

Минимальное значение — 0.