Получение информации о базе данных

Формат запроса

Для получения информации о базе данных необходимо отправить GET-запрос по URL:

https://cloud-api.yandex.net/v1/data/<context>/databases/<database_id>/?[fields=<значение>] 
<context>
Контекст базы данных (подробнее см. в разделе Структура хранилища).
<database_id>
Идентификатор базы данных.
fields (необязательный)
Список атрибутов базы данных, которые будут содержаться в ответе. Атрибуты перечисляются через запятую.

Заголовки

В заголовке Authorization необходимо указать авторизационный токен.

Формат ответа

В случае успеха сервер возвращает статус 200 OK. В теле ответа передается информация о базе данных, представленная в формате JSON или Protocol Buffers. В заголовке ETag содержится номер текущей ревизии базы данных.

Примеры запроса и ответа сервера приведен ниже.

Возможные ошибки

Код ошибки Описание

400

Некорректно указаны query-параметры limit или offset либо path-параметр context.

401

Клиент не авторизован.

403

Доступ запрещен. Возможно, у приложения недостаточно прав для данного действия.

404

Ресурс не найден.

406

Формат передаваемых данных не поддерживается.

423

В настоящий момент ресурс недоступен по техническим причинам.

429

Клиент слишком часто отправляет запросы.

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

Код ошибки Описание

400

Некорректно указаны query-параметры limit или offset либо path-параметр context.

401

Клиент не авторизован.

403

Доступ запрещен. Возможно, у приложения недостаточно прав для данного действия.

404

Ресурс не найден.

406

Формат передаваемых данных не поддерживается.

423

В настоящий момент ресурс недоступен по техническим причинам.

429

Клиент слишком часто отправляет запросы.

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

Формат ответа в случае ошибки описан в соответствующем разделе справочника.

Пример

Пример запроса информации о базе данных с идентификатором organizer и контекстом app:

curl -X GET -H "Authorization: OAuth <авторизационный токен>" -H "Content-Type: application/json" "https://cloud-api.yandex.net/v1/data/app/databases/organizer"

Ответ сервера:

HTTP/1.1 200 OK
...

{
    "handle": "uQtwtHiopt8I2P3Q14733932UFq45WLpQRAwWkwiR1460984922143"
    "records_count": 0,
    "created": "2014-10-28T14:54:20.118000+00:00",
    "modified": "2014-10-28T14:54:20.118000+00:00",
    "database_id": "organizer",
    "revision": 0,
    "size": 1024
}
handle
Уникальный идентификатор базы, который генерирует сервер. При удалении и создании базы этот идентификатор изменяется.
records_count
Количество записей в базе данных.
created
Дата и время создания.
modified
Дата и время последней модификации.
database_id
Идентификатор базы данных.
title
Название базы данных.
revision
Номер текущей ревизии базы данных.
size
Размер базы данных в байтах.