Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex DataLens Partners API
  • Принцип работы
  • Аутентификация в API
  • Справочник API
    • Обзор
    • Создание связи с клиентом
    • Удаление связи с клиентом
    • Информация о подключении
    • Обновление таблицы
    • Удаление таблицы
    • Запись данных
    • Удаление данных
  • Квоты и лимиты
  • Правила тарификации
  1. Справочник API
  2. Информация о подключении

Информация о подключении

  • HTTP-запрос
  • Path-параметры
  • Заголовки
  • Ответ

Возвращает информацию о подключении и таблицах.

HTTP-запрос

GET https://upload.datalens.yandex.net/provider/v1/connection/{connection_id}/info

Path-параметры

Параметр Описание
connection_id Идентификатор подключения.

Заголовки

Заголовок Описание
X-DL-Client-Id Идентификатор клиента.

Ответ

HTTP Code: 200 - OK

{
  "type": "string",
  "version": "string",
  "settings": {},
  "tables": [{
    "name": "string",
    "title": "string",
    "partition_key": [
      "string"
    ],
    "replacing_key": [
      "string"
    ],
    "meta": {
      "lastUploadTime": "2019-09-25T09:35:43.956Z"
    },
    "schema":[{
      "name": "string",
      "nullable": true,
      "title": "string",
      "type": "string"
      }
    ]}
  ]
}

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

Тип подключения.

version string

Версия подключения.

settings object

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

tables[] object

Информация о таблицах в подключении.

tables[].name string

Имя таблицы.

tables[].title string

Заголовок таблицы.

tables[].partition_key[] string

Ключ партиционирования.

tables[].replacing_key[] string

Ключ замены данных.


Позволяет заменить данные, которые были загружены ранее по этому ключу.
tables[].meta object

Метаданные таблицы.

tables[].meta.lastUploadTime string

Дата и время последнего обновления таблицы.
Строка в формате ISO 8601.

tables[].schema[] object

Схема таблицы.

tables[].schema[].name string

Имя поля.

tables[].schema[].nullable boolean

Указывает, может ли поле принимать значение NULL.

tables[].schema[].title string

Заголовок поля.

tables[].schema[].type string

Тип данных поля. Допустимые типы данных:

  • string
  • integer
  • float
  • date
  • datetime
  • boolean
  • geopoint

HTTP Code: 401 - Unauthorized

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

HTTP Code: 403 - Forbidden

У клиента не хватает прав на просмотр подключения.

HTTP Code: 5xx

Ошибка на стороне сервера.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Заголовки
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»