Метод list

Получает список ресурсов User для указанного кластера ClickHouse.

HTTP-запрос

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

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера для вывода списка пользователей ClickHouse. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "users": [
    {
      "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"
      }
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
users[] object

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

users[].
name
string

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

users[].
clusterId
string

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

users[].
permissions[]
object

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

users[].
permissions[].
databaseName
string

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

users[].
settings
object

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

users[].
settings.
readonly
integer (int64)

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

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

users[].
settings.
allowDdl
boolean (boolean)

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

users[].
settings.
insertQuorum
integer (int64)

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

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

users[].
settings.
insertQuorumTimeout
integer (int64)

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

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

users[].
settings.
selectSequentialConsistency
boolean (boolean)

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

users[].
settings.
maxReplicaDelayForDistributedQueries
integer (int64)

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

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

users[].
settings.
fallbackToStaleReplicasForDistributedQueries
boolean (boolean)

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

users[].
settings.
maxThreads
integer (int64)

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

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

users[].
settings.
maxBlockSize
integer (int64)

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

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

users[].
settings.
maxInsertBlockSize
integer (int64)

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

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

users[].
settings.
maxMemoryUsage
integer (int64)

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

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

users[].
settings.
maxMemoryUsageForUser
integer (int64)

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

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

users[].
settings.
maxRowsToRead
integer (int64)

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

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

users[].
settings.
maxBytesToRead
integer (int64)

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

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

users[].
settings.
readOverflowMode
string

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

users[].
settings.
maxRowsToGroupBy
integer (int64)

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

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

users[].
settings.
groupByOverflowMode
string

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

users[].
settings.
maxRowsToSort
integer (int64)

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

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

users[].
settings.
maxBytesToSort
integer (int64)

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

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

users[].
settings.
sortOverflowMode
string

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

users[].
settings.
maxResultRows
integer (int64)

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

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

users[].
settings.
maxResultBytes
integer (int64)

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

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

users[].
settings.
resultOverflowMode
string

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

users[].
settings.
maxRowsInDistinct
integer (int64)

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

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

users[].
settings.
maxBytesInDistinct
integer (int64)

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

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

users[].
settings.
distinctOverflowMode
string

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

users[].
settings.
maxRowsToTransfer
integer (int64)

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

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

users[].
settings.
maxBytesToTransfer
integer (int64)

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

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

users[].
settings.
transferOverflowMode
string

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

users[].
settings.
maxExecutionTime
integer (int64)

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

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

users[].
settings.
timeoutOverflowMode
string

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

users[].
settings.
maxColumnsToRead
integer (int64)

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

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

users[].
settings.
maxTemporaryColumns
integer (int64)

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

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

users[].
settings.
maxTemporaryNonConstColumns
integer (int64)

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

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

users[].
settings.
maxQuerySize
integer (int64)

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

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

users[].
settings.
maxAstDepth
integer (int64)

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

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

users[].
settings.
maxAstElements
integer (int64)

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

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

users[].
settings.
maxExpandedAstElements
integer (int64)

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

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

nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.