List

Retrieves the list of Elasticsearch users in the specified cluster.

TypeScript

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);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.mdb.clickhouse.v1.user_service_pb2 import ListUsersRequest
from yandex.cloud.mdb.clickhouse.v1.user_service_pb2_grpc import UserServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(UserServiceStub)
response = service.List(
    ListUsersRequest(
        cluster_id="clusterId",
        # page_size = 0,
        # page_token = "pageToken"
    )
)
print(response)

ListUsersRequest

clusterId : string

ID of the Elasticsearch cluster to list Elasticsearch users in.

To get the cluster ID, use 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 service returns a ListUsersResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

pageToken : string

Page token.

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

ListUsersResponse

users : User

List of Elasticsearch users.

nextPageToken : string

This token allows you to get the next page of results for list requests.

If the number of results is larger than ListUsersRequest.page_size, use the next_page_token as the value for the ListUsersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

User

An Elasticsearch user.

name : string

Name of the Elasticsearch user.

clusterId : string

ID of the Elasticsearch cluster the user belongs to.

---