Использование API панели мониторинга для создания панелей мониторинга и управления ими

REST API Databricks включает средства управления специально для управления панелями мониторинга ИИ/BI. На этой странице показано, как использовать средства API для создания панелей мониторинга и управления ими. Для выполнения этих задач с помощью пользовательского интерфейса см. в разделе Панели управления автора.

Заметка

Панели мониторинга AI/BI ранее были известны как панели мониторинга Lakeview. API Lakeview по-прежнему сохраняет это имя.

Необходимые условия

Настройте проверку подлинности для доступа к ресурсам Azure Databricks. Сведения о параметрах проверки подлинности и получении инструкций по настройке см. в статье Authorize access to Azure Databricks resources.
Вам нужны URL-адреса рабочей области, к которым требуется получить доступ. См. Имена экземпляров рабочей области, URL-адреса и идентификаторы.
Знакомство ссправочником по REST API Databricks.

Получение черновика панели мониторинга

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

Поле etag отслеживает последнюю версию панели мониторинга. Это можно использовать для проверки версии перед внесением дополнительных обновлений.

GET /api/2.0/lakeview/dashboards/04aab30f99ea444490c10c85852f216c

Response:

{
  "dashboard_id": "04aab30f99ea444490c10c85852f216c",
  "display_name": "Monthly Traffic Report",
  "path": "/path/to/dir/Monthly Traffic Report.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "47bb1c472649e711",
  "etag": "80611980",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

Обновление панели мониторинга

Вы можете использовать dashboard_id в предыдущем ответе, чтобы обновить новую панель мониторинга ИИ/BI, созданную с помощью этой операции. В следующем примере показан пример запроса и ответа. dashboard_id из предыдущего примера включается в качестве параметра пути.

Изменены display_name и warehouse_id. Обновленная панель мониторинга имеет новое имя и назначено хранилище по умолчанию, как показано в ответе. Поле etag является необязательным. Если версия, указанная в etag, не соответствует текущей версии, обновление отклоняется.

PATCH /api/2.0/lakeview/dashboards/04aab30f99ea444490c10c85852f216c

Request body:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "c03a4f8a7162bc9f",
  "etag": "80611980"
}

Response:

{
  "dashboard_id": "04aab30f99ea444490c10c85852f216c",
  "display_name": "Monthly Traffic Report 2",
  "path": "/path/to/dir/Monthly Traffic Report 2.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "c03a4f8a7162bc9f",
  "etag": "80611981",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

Создание панели мониторинга

Вы можете использовать конечную точку создания панели мониторинга в API Lakeview для перемещения панели мониторинга между рабочими областями. В следующем примере содержится пример текста запроса и ответа, который создает новую панель мониторинга. Ключ serialized_dashboard из предыдущего примера содержит все необходимые сведения для создания черновой версии панели мониторинга.

Пример содержит новое значение warehouse_id, соответствующее хранилищу в новой рабочей области. См. POST /api/2.0/lakeview/dashboards.

POST /api/2.0/lakeview/dashboards

Request body:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "parent_path": "/path/to/dir"
}

Response:

{
  "dashboard_id": "1e23fd84b6ac7894e2b053907dca9b2f",
  "display_name": "Monthly Traffic Report 2",
  "path": "/path/to/dir/Monthly Traffic Report 2.lvdash.json",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "warehouse_id": "5e2f98ab3476cfd0",
  "etag": "14350695",
  "serialized_dashboard": "{\"pages\":[{\"name\":\"b532570b\",\"displayName\":\"New Page\"}]}",
  "lifecycle_state": "ACTIVE",
  "parent_path": "/path/to/dir"
}

Единственным обязательным свойством в тексте запроса является display_name. Это средство может копировать содержимое панели мониторинга или создавать новые пустые панели мониторинга.

Публикация панели мониторинга

Можно использовать конечную точку публикации панели мониторинга, чтобы опубликовать панель мониторинга, задать учетные данные для зрителей и переопределить настройки warehouse_id, указанные в черновике панели мониторинга. Необходимо включить идентификатор UUID панели мониторинга в качестве параметра пути.

Текст запроса задает для свойства embed_credentials значение false. По умолчанию свойство embed_credentials имеет значение true. Внедрение учетных данных позволяет пользователям уровня учетной записи просматривать данные панели мониторинга. См. Опубликовать панель мониторинга. Новое значение warehouse_id опущено, поэтому опубликованная панель мониторинга использует то же хранилище, которое назначено черновику панели мониторинга.

POST /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

Request body:

{
  "embed_credentials": false
}

Response:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "embed_credentials": false,
  "revision_create_time": "2019-08-24T14:15:22Z"
}

Публикация информационной панели с учетными данными служебного принципала

Вы можете опубликовать панель мониторинга с внедренными учетными данными служебного субъекта, аутентифицировавшись как служебный субъект при вызове API. При публикации с помощью маркера субъекта-службы панель мониторинга публикуется с данными и разрешениями вычислений субъекта-службы, позволяя пользователям без прямого доступа к данным просматривать панель мониторинга.

Перед публикацией субъект-служба должен иметь по крайней мере разрешения CAN MANAGE на панели мониторинга, привилегии для всех источников данных, SELECT используемых на панели мониторинга, и РАЗРЕШЕНИЯ CAN USE в хранилище. Дополнительные сведения о создании служебных принципалов и генерации секретов OAuth см. в разделах Служебные принципалы и Авторизация доступа служебного принципала к Azure Databricks с помощью OAuth.

Сначала выполните проверку подлинности в качестве субъекта-службы, чтобы получить маркер доступа:

POST https://<databricks-instance>/oidc/v1/token

Request body (form-urlencoded):

grant_type=client_credentials&scope=all-apis

Authorization header:

Basic <base64-encoded-client-id:client-secret>

Response:

{
  "access_token": "eyJraWQiOiJkYTA4ZTVjZ...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Затем используйте токен доступа для публикации панели мониторинга с учетными данными служебного принципала.

POST /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

Authorization header:

Bearer <service-principal-access-token>

Request body:

{
  "embed_credentials": true,
  "warehouse_id": "5e2f98ab3476cfd0"
}

Response:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "embed_credentials": true,
  "revision_create_time": "2019-08-24T14:15:22Z"
}

Если embed_credentials задано значение true, средства просмотра панели мониторинга используют разрешения субъекта-службы для доступа к данным и вычислительным ресурсам. Пользователям требуются только разрешения для доступа к самому объекту панели мониторинга. Все запросы панели мониторинга выполняются с помощью удостоверения субъекта-службы, поэтому журналы аудита показывают субъект-службу в качестве исполнителя запроса.

Получение опубликованной панели мониторинга

Ответ от GET /api/2.0/lakeview/dashboards/{dashboard_id}/published аналогичен ответу, предоставленному в предыдущем примере. dashboard_id включается в качестве параметра пути.

GET /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

Response:

{
  "display_name": "Monthly Traffic Report 2",
  "warehouse_id": "5e2f98ab3476cfd0",
  "embed_credentials": false,
  "revision_create_time": "2019-08-24T14:15:22Z"
}

Отменить публикацию панели мониторинга

Черновик панели мониторинга сохраняется при использовании API Lakeview для снятия её с публикации. Этот запрос удаляет опубликованную версию панели мониторинга.

В следующем примере используется dashboard_id из предыдущего примера. Успешный запрос выдает код состояния 200. Нет текста ответа.

DELETE /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f/published

Панель управления мусором

Используйте DELETE /api/2.0/lakeview/dashboards/{dashboard_id}, чтобы отправить черновик панели мониторинга в корзину. Панель мониторинга по-прежнему может быть восстановлена.

DELETE /api/2.0/lakeview/dashboards/1e23fd84b6ac7894e2b053907dca9b2f