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

Метод list

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

HTTP-запрос

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

Path-параметры

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

Query-параметры

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

Ответ

HTTP Code: 200 - OK

{
  "databases": [
    {
      "name": "string",
      "clusterId": "string",
      "owner": "string",
      "lcCollate": "string",
      "lcCtype": "string",
      "extensions": [
        {
          "name": "string",
          "version": "string"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
databases[] object

Ресурс Database для PostgreSQL. Подробнее см. в разделе Developer's Guide.
databases[].
name		 string

Имя базы данных.
databases[].
clusterId		 string

Идентификатор кластера PostgreSQL, к которому принадлежит база данных.
databases[].
owner		 string

Имя пользователя, назначенного владельцем базы данных.
databases[].
lcCollate		 string

POSIX-локаль для порядка сортировки строк. Может быть установлен только во время создания.
databases[].
lcCtype		 string

POSIX-локаль для классификации символов. Может быть установлена только во время создания.
databases[].
extensions[]		 object

Расширения PostgreSQL, включенные для базы данных.
databases[].
extensions[].
name		 string

Имя расширения, например pg_trgm или pg_btree. Расширения, которые поддерживает Managed Service for PostgreSQL, перечислены в документации.
databases[].
extensions[].
version		 string

Версия расширения.
nextPageToken string

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