Method list

Retrieves the list of ClickHouse User resources in the specified cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the cluster to list ClickHouse users in. To get the cluster ID, use a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

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"
}
Field Description
users[] object

A ClickHouse User resource. For more information, see the Developer's guide.

users[].
name
string

Name of the ClickHouse user.

users[].
clusterId
string

ID of the ClickHouse cluster the user belongs to.

users[].
permissions[]
object

Set of permissions granted to the user.

users[].
permissions[].
databaseName
string

Name of the database that the permission grants access to.

users[].
settings
object

ClickHouse user settings. Supported settings are a limited subset of all settings described in ClickHouse documentation.

users[].
settings.
readonly
integer (int64)

See in-depth description in ClickHouse documentation.

Acceptable values are 0 to 2, inclusive.

users[].
settings.
allowDdl
boolean (boolean)

See in-depth description in ClickHouse documentation.

users[].
settings.
insertQuorum
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
insertQuorumTimeout
integer (int64)

Quorum write timeout in milliseconds. Default value: 60000. See in-depth description in ClickHouse documentation.

The minimum value is 1000.

users[].
settings.
selectSequentialConsistency
boolean (boolean)

See in-depth description in ClickHouse documentation.

users[].
settings.
maxReplicaDelayForDistributedQueries
integer (int64)

Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used. Default value: 300000. See in-depth description in ClickHouse documentation.

The minimum value is 1000.

users[].
settings.
fallbackToStaleReplicasForDistributedQueries
boolean (boolean)

See in-depth description in ClickHouse documentation.

users[].
settings.
maxThreads
integer (int64)

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

users[].
settings.
maxBlockSize
integer (int64)

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

users[].
settings.
maxInsertBlockSize
integer (int64)

See in-depth description in ClickHouse documentation.

Value must be greater than 0.

users[].
settings.
maxMemoryUsage
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxMemoryUsageForUser
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxRowsToRead
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxBytesToRead
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
readOverflowMode
string

See in-depth description in ClickHouse documentation.

users[].
settings.
maxRowsToGroupBy
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
groupByOverflowMode
string

See in-depth description in ClickHouse documentation.

users[].
settings.
maxRowsToSort
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxBytesToSort
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
sortOverflowMode
string

See in-depth description in ClickHouse documentation.

users[].
settings.
maxResultRows
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxResultBytes
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
resultOverflowMode
string

See in-depth description in ClickHouse documentation.

users[].
settings.
maxRowsInDistinct
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxBytesInDistinct
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
distinctOverflowMode
string

See in-depth description in ClickHouse documentation.

users[].
settings.
maxRowsToTransfer
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxBytesToTransfer
integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
transferOverflowMode
string

See in-depth description in ClickHouse documentation.

users[].
settings.
maxExecutionTime
integer (int64)

Maximum query execution time in milliseconds. See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
timeoutOverflowMode
string

See in-depth description in ClickHouse documentation.

users[].
settings.
maxColumnsToRead
integer (int64)

Maximum number of columns that can be read from a table in a single query. See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxTemporaryColumns
integer (int64)

Maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxTemporaryNonConstColumns
integer (int64)

Maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. See in-depth description in ClickHouse documentation.

The minimum value is 0.

users[].
settings.
maxQuerySize
integer (int64)

The maximum part of a query that can be taken to RAM for parsing with the SQL parser, in bytes. Default value: 262144. See in-depth description in ClickHouse documentation.

Value must be greater than 0.

users[].
settings.
maxAstDepth
integer (int64)

Maximum depth of query syntax tree. Default value: 1000. See in-depth description in ClickHouse documentation.

Value must be greater than 0.

users[].
settings.
maxAstElements
integer (int64)

Maximum size of query syntax tree in number of nodes. Default value: 50000. See in-depth description in ClickHouse documentation.

Value must be greater than 0.

users[].
settings.
maxExpandedAstElements
integer (int64)

Maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk. Default value: 500000.

Value must be greater than 0.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.