Управление ролями и пользователями

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом User.List и выполните запрос, например, с помощью cURL:

   curl \
       --request GET \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --url 'https://mdb.api.yandexcloud.kz/managed-greenplum/v1/clusters/<идентификатор_кластера>/users'
   

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом UserService.List и выполните запрос ListUsersRequest, например, с помощью gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/user_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>"
           }' \
       mdb.api.yandexcloud.kz:443 \
       yandex.cloud.mdb.greenplum.v1.UserService.List
   

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Для выполнения операций с помощью SQL подключитесь к базе данных от имени пользователя с ролью mdb_admin.

Запросы к pg_roles возвращают пользователей и остальные роли внутри базы данных.

Выполните команду:

SELECT rolname FROM pg_roles;

Чтобы посмотреть список ролей с их привилегиями, выполните команду:

SELECT
    rolname,
    rolsuper,
    rolcreatedb,
    rolcreaterole,
    rolinherit,
    rolcanlogin,
    rolconnlimit,
    rolcreaterextgpfd
FROM pg_roles;

Результат:

    rolname     | rolsuper | rolcreatedb | rolcreaterole | rolinherit | rolcanlogin | rolconnlimit | rolcreaterextgpfd
----------------+----------+-------------+---------------+------------+-------------+--------------+-------------------
 mdb_admin      | f        | f           | f             | t          | f           |           -1 | f
 gpadmin        | t        | t           | t             | t          | t           |           -1 | t
 monitor        | t        | f           | f             | t          | t           |           -1 | f
 user1          | f        | t           | t             | t          | t           |           -1 | t

Где:

• t — наличие привилегии.
• f — отсутствие привилегии.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом User.Create и выполните запрос, например, с помощью cURL:

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.yandexcloud.kz/managed-greenplum/v1/clusters/<идентификатор_кластера>/users' \
       --data '{
                 "user": {
                   "name": "<имя_пользователя>",
                   "password": "<пароль>",
                   "login": <разрешение_на_вход>,
                   "resourceGroup": "<имя_ресурсной_группы>",
                   "settings": {
                     "poolMode": "<режим_пула>",
                     "poolSize": "<количество_серверных_соединений>",
                     "poolClientIdleTimeout": "<время_ожидания_клиента>",
                     "poolIdleInTransactionTimeout": "<время_ожидания_клиента_в_транзакции>"
                   }
                 }
               }'
   

   Где:

   • password — пароль пользователя.
   • login — разрешение на вход в базу данных: true или false. Значение по умолчанию — true. При значении false создается роль без возможности авторизации.
   • resourceGroup — ресурсная группа, к которой относятся запросы пользователя.
   • settings.poolMode — режим пула соединений Odyssey: SESSION или TRANSACTION.
   • settings.poolSize — количество серверных соединений в пуле Odyssey.
   • settings.poolClientIdleTimeout — время неактивности клиентского соединения в секундах, после которого соединение разрывается.
   • settings.poolIdleInTransactionTimeout — время неактивности клиентского соединения с открытой транзакцией в секундах, после которого соединение разрывается.

   Настройки пулера соединений Odyssey, заданные на уровне пользователя, применяются только к этому пользователю. Если отдельная настройка не задана, используется соответствующая настройка уровня кластера.

   Пользовательские настройки применяются к подключениям только при наличии подходящего правила аутентификации, в котором значение поля user совпадает с именем пользователя.

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом UserService.Create и выполните запрос CreateUserRequest, например, с помощью gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/user_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "user": {
                 "name": "<имя_пользователя>",
                 "password": "<пароль>",
                 "login": <разрешение_на_вход>,
                 "resource_group": "<имя_ресурсной_группы>",
                 "settings": {
                   "pool_mode": "<режим_пула>",
                   "pool_size": "<количество_серверных_соединений>",
                   "pool_client_idle_timeout": "<время_ожидания_клиента>",
                   "pool_idle_in_transaction_timeout": "<время_ожидания_клиента_в_транзакции>"
                 }
               }
           }' \
       mdb.api.yandexcloud.kz:443 \
       yandex.cloud.mdb.greenplum.v1.UserService.Create
   

   Где:

   • password — пароль пользователя.
   • login — разрешение на вход в базу данных: true или false. Значение по умолчанию — true. При значении false создается роль без возможности авторизации.
   • resource_group — ресурсная группа, к которой относятся запросы пользователя.
   • settings.pool_mode — режим пула соединений Odyssey: SESSION или TRANSACTION.
   • settings.pool_size — количество серверных соединений в пуле Odyssey.
   • settings.pool_client_idle_timeout — время неактивности клиентского соединения в секундах, после которого соединение разрывается.
   • settings.pool_idle_in_transaction_timeout — время неактивности клиентского соединения с открытой транзакцией в секундах, после которого соединение разрывается.

   Настройки пулера соединений Odyssey, заданные на уровне пользователя, применяются только к этому пользователю. Если отдельная настройка не задана, используется соответствующая настройка уровня кластера.

   Пользовательские настройки применяются к подключениям только при наличии подходящего правила аутентификации, в котором значение поля user совпадает с именем пользователя.

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Для выполнения операций с помощью SQL подключитесь к базе данных от имени пользователя с ролью mdb_admin.

Выполните команду:

CREATE ROLE <имя_роли> <список_атрибутов>;

Чтобы создать пользователя, добавьте роли атрибут LOGIN.

Доступные атрибуты читайте в разделе Атрибуты.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом User.Update и выполните запрос, например с помощью cURL:

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.yandexcloud.kz/managed-greenplum/v1/clusters/<идентификатор_кластера>/users/<имя_пользователя>' \
       --data '{
                 "updateMask": "password",
                 "user": {
                   "name": "<имя_пользователя>",
                   "password": "<новый_пароль>"
                 }
               }'
   

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом UserService.Update и выполните запрос UpdateUserRequest, например с помощью gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/user_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "update_mask": {
                 "paths": [
                   "password"
                 ]
               },
               "user": {
                 "name": "<имя_пользователя>",
                 "password": "<новый_пароль>"
               }
           }' \
       mdb.api.yandexcloud.kz:443 \
       yandex.cloud.mdb.greenplum.v1.UserService.Update
   

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Для выполнения операций с помощью SQL подключитесь к базе данных от имени пользователя с ролью mdb_admin.

Чтобы изменить пароль пользователя, выполните команду:

ALTER ROLE <имя_пользователя> PASSWORD '<новый_пароль>';

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом User.Update и выполните запрос, например с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.yandexcloud.kz/managed-greenplum/v1/clusters/<идентификатор_кластера>/users/<имя_пользователя>' \
       --data '{
                 "updateMask": "login,resourceGroup,settings.poolMode,settings.poolSize,settings.poolClientIdleTimeout,settings.poolIdleInTransactionTimeout",
                 "user": {
                   "name": "<имя_пользователя>",
                   "login": <разрешение_на_вход>,
                   "resourceGroup": "<имя_ресурсной_группы>",
                   "settings": {
                     "poolMode": "<режим_пула>",
                     "poolSize": "<количество_серверных_соединений>",
                     "poolClientIdleTimeout": "<время_ожидания_клиента>",
                     "poolIdleInTransactionTimeout": "<время_ожидания_клиента_в_транзакции>"
                   }
                 }
               }'
   

   Где:

   • updateMask — перечень изменяемых полей в одну строку через запятую.

   • login — разрешение на вход в базу данных: true или false.

   • resourceGroup — ресурсная группа, к которой относятся запросы пользователя.

   • settings — настройки Odyssey на уровне пользователя:

     • poolMode — режим пула соединений: SESSION или TRANSACTION;
     • poolSize — количество серверных соединений в пуле;
     • poolClientIdleTimeout — время неактивности клиентского соединения в секундах, после которого соединение разрывается;
     • poolIdleInTransactionTimeout — время неактивности клиентского соединения с открытой транзакцией в секундах, после которого соединение разрывается.

   Чтобы сбросить настройку Odyssey и использовать значение уровня кластера, укажите соответствующее поле в updateMask, но не передавайте его значение в объекте settings.

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом UserService.Update и выполните запрос UpdateUserRequest, например с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/user_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "update_mask": {
                 "paths": [
                   "login",
                   "resource_group",
                   "settings.pool_mode",
                   "settings.pool_size",
                   "settings.pool_client_idle_timeout",
                   "settings.pool_idle_in_transaction_timeout"
                 ]
               },
               "user": {
                 "name": "<имя_пользователя>",
                 "login": <разрешение_на_вход>,
                 "resource_group": "<имя_ресурсной_группы>",
                 "settings": {
                   "pool_mode": "<режим_пула>",
                   "pool_size": "<количество_серверных_соединений>",
                   "pool_client_idle_timeout": "<время_ожидания_клиента>",
                   "pool_idle_in_transaction_timeout": "<время_ожидания_клиента_в_транзакции>"
                 }
               }
           }' \
       mdb.api.yandexcloud.kz:443 \
       yandex.cloud.mdb.greenplum.v1.UserService.Update
   

   Где:

   • update_mask — перечень изменяемых полей в виде массива строк paths[].

   • login — разрешение на вход в базу данных: true или false.

   • resource_group — ресурсная группа, к которой относятся запросы пользователя.

   • settings — настройки Odyssey на уровне пользователя:

     • pool_mode — режим пула соединений: SESSION или TRANSACTION;
     • pool_size — количество серверных соединений в пуле;
     • pool_client_idle_timeout — время неактивности клиентского соединения в секундах, после которого соединение разрывается;
     • pool_idle_in_transaction_timeout — время неактивности клиентского соединения с открытой транзакцией в секундах, после которого соединение разрывается.

   Чтобы сбросить настройку Odyssey и использовать значение уровня кластера, укажите соответствующее поле в update_mask.paths, но не передавайте его значение в объекте settings.

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

С помощью SQL можно изменить атрибуты роли и задать для нее настройки СУБД.

Для выполнения операций с помощью SQL подключитесь к базе данных от имени пользователя с ролью mdb_admin.

Чтобы изменить атрибуты роли, выполните команду:

ALTER ROLE <имя_роли> <список_атрибутов>;

Доступные атрибуты читайте в разделе Атрибуты.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом User.Delete и выполните запрос, например с помощью cURL:

   curl \
       --request DELETE \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --url 'https://mdb.api.yandexcloud.kz/managed-greenplum/v1/clusters/<идентификатор_кластера>/users/<имя_пользователя>'
   

   Идентификатор кластера можно получить со списком кластеров в каталоге, а имя пользователя — со списком пользователей кластера.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом UserService.Delete и выполните запрос DeleteUserRequest, например с помощью gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/user_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "user_name": "<имя_пользователя>"
           }' \
       mdb.api.yandexcloud.kz:443 \
       yandex.cloud.mdb.greenplum.v1.UserService.Delete
   

   Идентификатор кластера можно получить со списком кластеров в каталоге, а имя пользователя — со списком пользователей кластера.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Для выполнения операций с помощью SQL подключитесь к базе данных от имени пользователя с ролью mdb_admin.

Перед удалением роли удалите все объекты, которыми она владеет, или переназначьте их права собственности и отзовите все привилегии для других объектов.

Выполните команду:

DROP ROLE <имя_роли>;