Подключиться
Войти
Yandex Managed Service for PostgreSQL

Метод create

Создает пользователя PostgreSQL в указанном кластере.

HTTP-запрос

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

Path-параметры

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

Параметры в теле запроса

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

Обязательное поле. Свойства создаваемого пользователя.
userSpec.
name		 string

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

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

Обязательное поле. Пароль пользователя PostgreSQL.

Длина строки в символах должна быть от 8 до 128.
userSpec.
permissions[]		 object

Набор разрешений, которые следует предоставить пользователю.
userSpec.
permissions[].
databaseName		 string

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

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

Минимальное значение — 10.
userSpec.
settings		 object

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

Пользовательские параметры PostgreSQL
userSpec.
settings.
defaultTransactionIsolation		 string
userSpec.
settings.
lockTimeout		 integer (int64)

в миллисекундах.
userSpec.
settings.
logMinDurationStatement		 integer (int64)

в миллисекундах.
userSpec.
settings.
synchronousCommit		 string
userSpec.
settings.
tempFileLimit		 integer (int64)

в байтах.
userSpec.
login		 boolean (boolean)

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

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

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

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе Объект Operation.

Поле Описание
id string

Идентификатор операции.
description string

Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

Строка в формате RFC3339.
createdBy string

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

Строка в формате RFC3339.
done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.
error.
code		 integer (int32)

Код ошибки. Значение из списка google.rpc.Code.
error.
message		 string

Текст ошибки.
error.
details[]		 object

Список сообщений с подробными сведениями об ошибке.
response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.