Метод list
Получает список ресурсов User для указанного кластера PostgreSQL.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/users
Path-параметры
| Параметр | Описание |
|---|---|
| clusterId | Обязательное поле. Идентификатор кластера для вывода списка пользователей PostgreSQL. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
| Параметр | Описание |
|---|---|
| pageSize | Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
| pageToken | Токен страницы. Установите значение page_token равным значению поля 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",
"logStatement": "string"
},
"login": true,
"grants": [
"string"
]
}
],
"nextPageToken": "string"
}
| Поле | Описание |
|---|---|
| users[] | object Ресурс User для PostgreSQL. Подробнее см. в разделе Концепции. |
| users[]. name |
string Имя пользователя PostgreSQL. |
| users[]. clusterId |
string Идентификатор кластера PostgreSQL, к которому принадлежит пользователь. |
| users[]. permissions[] |
object Набор разрешений, предоставленных пользователю для доступа к определенным базам данных. |
| users[]. permissions[]. databaseName |
string Имя базы данных, к которой предоставляет доступ разрешение. |
| users[]. connLimit |
string (int64) Максимальное количество доступных пользователю подключений к базе данных. При использовании сессионного пулинга эта настройка ограничивает количество подключений к каждому отдельному хосту в кластере PostgreSQL. В этом случае значение настройки должно быть больше общего числа подключений, которые могут быть открыты сервисами бэкенда для доступа к кластеру PostgreSQL. Значение этой настройки не должно превышать значения настройки Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections. При использовании транзакционного пулинга эта настройка ограничивает количество активных транзакций пользователя, поэтому в этом режиме пользователь может открывать тысячи подключений, но одновременно будет установлено только Минимальное значение: |
| users[]. settings |
object Пользовательские настройки PostgreSQL. |
| users[]. settings. defaultTransactionIsolation |
string Для каждой транзакции в SQL устанавливается уровень изоляции. Эта настройка определяет уровень изоляции, который будет устанавливаться по умолчанию для новых транзакций SQL. См. подробное описание в документации PostgreSQL.
|
| users[]. settings. lockTimeout |
integer (int64) Максимальная длительность ожидания (в миллисекундах) любым оператором получения блокировки таблицы, индекса, строки или другого объекта базы данных. Если ожидание не закончилось за указанное время, оператор прерывается. Значение по умолчанию: |
| users[]. settings. logMinDurationStatement |
integer (int64) Эта настройка управляет логированием длительности выполнения команд SQL. В лог записывается продолжительность выполнения всех команд, время обработки которых равно или превышает указанное в значении настройки количество миллисекунд. Например, при значении настройки Значение Значение См. подробное описание в документации PostgreSQL. |
| users[]. settings. synchronousCommit |
string Эта настройка определяет, будет ли СУБД выполнять операцию подтверждения транзакции синхронно. Синхронность операции означает, что кластер будет ждать выполнения синхронных операций прежде чем подтвердить транзакцию клиенту. Эти операции гарантируют различные уровни сохранности и видимости данных в кластере. См. подробное описание в документации PostgreSQL.
|
| users[]. settings. tempFileLimit |
integer (int64) Максимальный объем дискового пространства (в килобайтах), который один процесс сможет использовать для временных файлов. Транзакция, которая попытается превысить этот предел, будет отменена. Большие запросы из-за их размера выполняются PostgreSQL не в оперативной памяти, а на диске. Слишком большие запросы могут нагрузить диск и помешать выполнению других запросов. Эта настройка предотвращает выполнение запросов, которые могут сильно повлиять на производительность, ограничивая размер временных файлов. |
| users[]. settings. logStatement |
string Эта настройка определяет, какие команды SQL должны записываться в лог (на уровне пользователя). См. подробное описание в документации PostgreSQL.
|
| users[]. login |
boolean (boolean) Этот флаг определяет, может ли пользователь войти в базу данных PostgreSQL. Значение по умолчанию: |
| users[]. grants[] |
string Роли и права, предоставленные пользователю ( Дополнительные сведения см. в документации. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению |
| nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте |