Service doublecloud.clickhouse.v1.UserService

Get

Returns the specified ClickHouse user.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`user_name`	string Required. Name of the user.

Response

Field	Description
`name`	string Name of the ClickHouse user.
`cluster_id`	string ID of the ClickHouse cluster.
`default_roles`	doublecloud.clickhouse.v1.DefaultRoles Default role settigns.
`grantees`	doublecloud.clickhouse.v1.Grantees Grantees settings.
`privileges`	doublecloud.clickhouse.v1.Privileges List of the privileges of the user.
`settings`	doublecloud.clickhouse.v1.Settings Settings and constraints of the user.
`quota_names`	doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the user.
`assigned_roles`	doublecloud.clickhouse.v1.AssignedRoles List of assigned roles to the user.

List

Retrieves a list of ClickHouse users.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`paging`	doublecloud.v1.Paging Paging information of the request.

Response

Field	Description
`users`	list Requested list of ClickHouse users.
`users[]`	doublecloud.clickhouse.v1.User
`next_page`	doublecloud.v1.NextPage Paging information of the response.

Create

Creates a new ClickHouse user.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`user_name`	string Required. Name of the user.
`authentication`	doublecloud.clickhouse.v1.Authentication Authentication params of the user.
`default_roles`	doublecloud.clickhouse.v1.DefaultRoles Default role settigns.
`grantees`	doublecloud.clickhouse.v1.Grantees Grantees settings.
`privileges`	doublecloud.clickhouse.v1.Privileges List of the privileges that define the scope of queries the a user can execute.
`settings`	doublecloud.clickhouse.v1.Settings Settings and constraints.
`quota_names`	doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the user.
`assigned_roles`	doublecloud.clickhouse.v1.AssignedRoles List of assigned roles to the user.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Update

Modifies the specified ClickHouse user.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`user_name`	string Required. Name of the user.
`authentication`	doublecloud.clickhouse.v1.Authentication Authentication params of the user.
`default_roles`	doublecloud.clickhouse.v1.DefaultRoles Default role settigns.
`grantees`	doublecloud.clickhouse.v1.Grantees Grantees settings.
`privileges`	doublecloud.clickhouse.v1.Privileges List of the privileges that define the scope of queries the a user can execute.
`settings`	doublecloud.clickhouse.v1.Settings Settings and constraints.
`quota_names`	doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the user.
`assigned_roles`	doublecloud.clickhouse.v1.AssignedRoles List of assigned roles to the user.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Delete

Deletes the specified ClickHouse user.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`user_name`	string Required. Name of the user to delete.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

GetRole

Returns the specified ClickHouse role.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`role_name`	string Required. Name of the role.

Response

Field	Description
`name`	string Name of the ClickHouse user.
`cluster_id`	string ID of the ClickHouse cluster.
`privileges`	doublecloud.clickhouse.v1.Privileges List of the privileges of the role.
`settings`	doublecloud.clickhouse.v1.Settings Settings and constraints of the role.
`quota_names`	doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the role.

ListRoles

Retrieves a list of ClickHouse roles.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`paging`	doublecloud.v1.Paging Paging information of the request.

Response

Field	Description
`roles`	list Requested list of ClickHouse roles.
`roles[]`	doublecloud.clickhouse.v1.Role
`next_page`	doublecloud.v1.NextPage Paging information of the response.

CreateRole

Creates a new ClickHouse role.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`role_name`	string Required. Name of the role.
`privileges`	doublecloud.clickhouse.v1.Privileges List of the privileges that define the scope of queries the a user with that role can execute.
`settings`	doublecloud.clickhouse.v1.Settings Settings and constraints.
`quota_names`	doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the role.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

UpdateRole

Modifies the specified ClickHouse role.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`role_name`	string Required. Name of the role.
`privileges`	doublecloud.clickhouse.v1.Privileges List of the privileges that define the scope of queries the a user with that role can execute.
`settings`	doublecloud.clickhouse.v1.Settings Settings and constraints.
`quota_names`	doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the role.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

DeleteRole

Deletes the specified ClickHouse role.

Request

Field	Description
`cluster_id`	string Required. ID of the ClickHouse cluster.
`role_name`	string Required. Name of the role to delete.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

OperationService

VersionService