Метод list

Получает список ресурсов User для указанного кластера PostgreSQL.

HTTP-запрос

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

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера для вывода списка пользователей PostgreSQL. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "users": [
    {
      "name": "string",
      "clusterId": "string",
      "permissions": [
        {
          "databaseName": "string"
        }
      ],
      "connLimit": "string",
      "settings": {
        "defaultTransactionIsolation": "string",
        "lockTimeout": "integer",
        "logMinDurationStatement": "integer",
        "synchronousCommit": "string",
        "tempFileLimit": "integer"
      },
      "login": true,
      "grants": [
        "string"
      ]
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
users[] object

Ресурс User для PostgreSQL. Подробнее см. в разделе Developer's Guide.

users[].
name
string

Имя пользователя PostgreSQL.

users[].
clusterId
string

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

users[].
permissions[]
object

Набор разрешений, предоставленных пользователю.

users[].
permissions[].
databaseName
string

Имя базы данных, к которой предоставляет доступ разрешение.

users[].
connLimit
string (int64)

Количество доступных пользователю подключений к базе данных.

users[].
settings
object

Настройки PostgreSQL для этого пользователя

Пользовательские параметры PostgreSQL

users[].
settings.
defaultTransactionIsolation
string
users[].
settings.
lockTimeout
integer (int64)

в миллисекундах.

users[].
settings.
logMinDurationStatement
integer (int64)

в миллисекундах.

users[].
settings.
synchronousCommit
string
users[].
settings.
tempFileLimit
integer (int64)

в байтах.

users[].
login
boolean (boolean)

Пользователь может войти (по умолчанию True).

users[].
grants[]
string

Пользовательские гранты (GRANT <роль> TO <пользователь>), роль должна быть другим пользователем.

Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.

nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.