Метод 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",
"insertQuorumTimeout": "integer",
"selectSequentialConsistency": true,
"maxReplicaDelayForDistributedQueries": "integer",
"fallbackToStaleReplicasForDistributedQueries": true,
"maxThreads": "integer",
"maxBlockSize": "integer",
"maxInsertBlockSize": "integer",
"maxMemoryUsage": "integer",
"maxMemoryUsageForUser": "integer",
"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"
}
}
Ресурс User для ClickHouse. Подробнее см. в разделе Developer's guide.
| Поле | Описание |
|---|---|
| name | string Имя пользователя базы данных ClickHouse. |
| clusterId | string Идентификатор кластера ClickHouse, к которому принадлежит пользователь. |
| permissions[] | object Набор разрешений, предоставленных пользователю. |
| permissions[]. databaseName |
string Имя базы данных, к которой предоставляет доступ разрешение. |
| settings | object Пользовательские настройки ClickHouse. Поддерживаемые параметры входят в число параметров, описанных в разделе ClickHouse documentation. |
| settings. readonly |
integer (int64) См. подробное описание в ClickHouse documentation. Допустимые значения — от 0 до 2 включительно. |
| settings. allowDdl |
boolean (boolean) См. подробное описание в ClickHouse documentation. |
| settings. insertQuorum |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. insertQuorumTimeout |
integer (int64) Время ожидания записи для кворума в миллисекундах. Значение по умолчанию: 60000. См. подробное описание в ClickHouse documentation. Минимальное значение — 1000. |
| settings. selectSequentialConsistency |
boolean (boolean) См. подробное описание в ClickHouse documentation. |
| settings. maxReplicaDelayForDistributedQueries |
integer (int64) Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, реплика перестает использоваться. Значение по умолчанию: 300000. См. подробное описание в ClickHouse documentation. Минимальное значение — 1000. |
| settings. fallbackToStaleReplicasForDistributedQueries |
boolean (boolean) См. подробное описание в ClickHouse documentation. |
| settings. maxThreads |
integer (int64) См. подробное описание в ClickHouse documentation. Значение должно быть больше 0. |
| settings. maxBlockSize |
integer (int64) См. подробное описание в ClickHouse documentation. Значение должно быть больше 0. |
| settings. maxInsertBlockSize |
integer (int64) См. подробное описание в ClickHouse documentation. Значение должно быть больше 0. |
| settings. maxMemoryUsage |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxMemoryUsageForUser |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxRowsToRead |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxBytesToRead |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. readOverflowMode |
string См. подробное описание в ClickHouse documentation. |
| settings. maxRowsToGroupBy |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. groupByOverflowMode |
string См. подробное описание в ClickHouse documentation. |
| settings. maxRowsToSort |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxBytesToSort |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. sortOverflowMode |
string См. подробное описание в ClickHouse documentation. |
| settings. maxResultRows |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxResultBytes |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. resultOverflowMode |
string См. подробное описание в ClickHouse documentation. |
| settings. maxRowsInDistinct |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxBytesInDistinct |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. distinctOverflowMode |
string См. подробное описание в ClickHouse documentation. |
| settings. maxRowsToTransfer |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxBytesToTransfer |
integer (int64) См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. transferOverflowMode |
string См. подробное описание в ClickHouse documentation. |
| settings. maxExecutionTime |
integer (int64) Максимальное время выполнения запроса в миллисекундах. См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. timeoutOverflowMode |
string См. подробное описание в ClickHouse documentation. |
| settings. maxColumnsToRead |
integer (int64) Максимальное количество столбцов, которые можно прочитать из таблицы в одном запросе. См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxTemporaryColumns |
integer (int64) Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, включая постоянные столбцы. См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxTemporaryNonConstColumns |
integer (int64) Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, за исключением постоянных столбцов. См. подробное описание в ClickHouse documentation. Минимальное значение — 0. |
| settings. maxQuerySize |
integer (int64) Наибольшая часть запроса, которая может быть передана в RAM для разбора с помощью анализатора SQL, в байтах. Значение по умолчанию: 262144. См. подробное описание в ClickHouse documentation. Значение должно быть больше 0. |
| settings. maxAstDepth |
integer (int64) Максимальная глубина синтаксического дерева запроса. Значение по умолчанию: 1000. См. подробное описание в ClickHouse documentation. Значение должно быть больше 0. |
| settings. maxAstElements |
integer (int64) Максимальный размер синтаксического дерева запроса в количестве узлов. Значение по умолчанию: 50000. См. подробное описание в ClickHouse documentation. Значение должно быть больше 0. |
| settings. maxExpandedAstElements |
integer (int64) Максимальный размер синтаксического дерева запроса в количестве узлов после раскрытия псевдонимов и звездочки. Значение по умолчанию: 500000. Значение должно быть больше 0. |