Skip to main content

List

Retrieves the list of users in a cluster.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListUsersRequest = cloudApi.mdb.clickhouse_user_service.ListUsersRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.UserServiceClient);

  const result = await client.list(
    ListUsersRequest.fromPartial({
      clusterId: "clusterId",
      // pageSize: 0,
      // pageToken: "pageToken"
    })
  );
  console.log(result);
})();

ListUsersRequest​

clusterId : string​

ID of the cluster to list the users in.

To get this ID, make a ClusterService.List request.

pageSize : int64​

The maximum number of results per page to return.

If the number of available results is larger than page_size, the API returns a ListUsersResponse.next_page_token that can be used to get the next page of results in the subsequent UserService.List requests.

pageToken : string​

Page token that can be used to iterate through multiple pages of results.

To get the next page of results, set page_token to the ListUsersResponse.next_page_token returned by the previous UserService.List request.

ListUsersResponse​

users : User​

List of users.

nextPageToken : string​

The token that can be used to get the next page of results.

If the number of results is larger than ListUsersRequest.page_size, use the next_page_token as the value for the ListUsersRequest.page_token in the subsequent UserService.List request to iterate through multiple pages of results.

Each of the subsequent UserService.List requests should use the next_page_token value returned by the previous request to continue paging through the results.

User​

An object that represents MySQL user.

See the documentation for details.

name : string​

Name of the user.

clusterId : string​

ID of the cluster the user belongs to.

permissions : Permission​

Set of permissions granted to the user.

globalPermissions : GlobalPermission​

Set of global permissions to grant to the user.

connectionLimits : ConnectionLimits​

Set of user connection limits.

authenticationPlugin : AuthPlugin​

User authentication plugin.

Permission​

Privilege​
  • PRIVILEGE_UNSPECIFIED

  • ALL_PRIVILEGES

    All privileges that can be made available to the user.

  • ALTER

    Altering tables.

  • ALTER_ROUTINE

    Altering stored routines and functions.

  • CREATE

    Creating tables or indexes.

  • CREATE_ROUTINE

    Creating stored routines.

  • CREATE_TEMPORARY_TABLES

    Creating temporary tables.

  • CREATE_VIEW

    Creating views.

  • DELETE

    Deleting tables.

  • DROP

    Removing tables or views.

  • EVENT

    Creating, altering, dropping, or displaying events for the Event Scheduler.

  • EXECUTE

    Executing stored routines.

  • INDEX

    Creating and removing indexes.

  • INSERT

    Inserting rows into the database.

  • LOCK_TABLES

    Using LOCK TABLES statement for tables available with SELECT privilege.

  • SELECT

    Selecting rows from tables. Some SELECT statements can be allowed without the SELECT privilege. All statements that read column values require the SELECT privilege. See MySQL documentation for details.

  • SHOW_VIEW

    Using the SHOW CREATE VIEW statement. Also needed for views used with EXPLAIN.

  • TRIGGER

    Creating, removing, executing, or displaying triggers for a table.

  • UPDATE

    Updating rows in the database.

  • REFERENCES

    Creation of a foreign key constraint for the parent table.

databaseName : string​

Name of the database that the permission grants access to.

roles : Privilege​

Roles granted to the user within the database.

See the documentation for details.

ConnectionLimits​

maxQuestionsPerHour : google.protobuf.Int64Value​

The maximum permitted number of user questions per hour.

maxUpdatesPerHour : google.protobuf.Int64Value​

The maximum permitted number of user updates per hour.

maxConnectionsPerHour : google.protobuf.Int64Value​

The maximum permitted number of simultaneous client connections per hour.

maxUserConnections : google.protobuf.Int64Value​

The maximum number of simultaneous connections permitted to any given MySQL user account.