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

Статья
02/04/2025

REST API Databricks включает средства управления специально для управления панелями мониторинга ИИ/BI. В этой статье показано, как создать новую панель мониторинга ИИ/BI на существующей устаревшей панели мониторинга. Затем показано, как использовать средства API для управления панелью мониторинга.

Заметка

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

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

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

перенос панели мониторинга

Вы можете создать новую панель мониторинга ИИ/BI на существующей устаревшей панели мониторинга. Для конечной точки панели мониторинга миграции в API Lakeview требуется source_dashboard_id. При необходимости можно включить отображаемое имя и путь, в котором должна храниться новая панель мониторинга.

Получить предыдущие панели мониторинга

Чтобы получить source_dashboard_id, используйте API устаревших панелей мониторинга, чтобы получить список всех панелей мониторинга в рабочей области. Каждый объект панели мониторинга в списке results содержит идентификатор UUID, который можно использовать для ссылки на устаревшую панель мониторинга в службах REST API Azure Databricks.

В следующем примере приведен пример запроса и ответа для получения объектов панели мониторинга на конечной точке. Некоторые сведения о ответе были опущены для ясности. Полный описание этой конечной точки и примера ответа см. в GET /api/workspace/dashboards/list.

Идентификатор UUID для устаревшей панели мониторинга — это id с верхнего уровня списка объектов, возвращенных в results. Для устаревших панелей мониторинга идентификатор UUID выглядит как 4e443c27-9f61-4f2e-a12d-ea5668460bf1.

GET /api/workspace/dashboards/list

Query Parameters:

{
"page_size": <optional>,
"page": <optional>,
"order": <optional>
"q": <optional>
}

Response:

{
  "count": 1,
  "page": 1,
  "page_size": 25,
  "results": [
    {
      "id": "4e443c27-9f61-4f2e-a12d-ea5668460bf1",
      "slug": "sales-dashboard",
      "parent": "folders/2025532471912059",
      ...
    }
  ]
}

Перенос устаревшей панели мониторинга

Используйте UUID, связанный с устаревшей панелью мониторинга, чтобы создать копию, которая автоматически преобразуется в новую панель мониторинга AI/BI. Это работает так же, как инструмент Clone для панели ИИ/BI, доступный в пользовательском интерфейсе. Сведения о выполнении этой операции с помощью пользовательского интерфейса Azure Databricks см. в клонировать устаревшую панель мониторинга на панель мониторинга ИИ/BI.

Идентификатор UUID устаревшей панели мониторинга, которую вы хотите преобразовать, требуется в тексте запроса. При необходимости можно включить новое значение display_name и parent_path, определяющие путь к рабочей области, в которой находится папка, где должна храниться преобразованная панель мониторинга.

Ответ включает dashboard_id, идентификатор UUID для новой панели мониторинга. UUID для панели мониторинга AI/BI — это 32-цифрное буквенно-цифровое значение, например 04aab30f99ea444490c10c85852f216c. Ее можно использовать для идентификации этой панели мониторинга в пространстве имен Lakeview и различных службах REST API Azure Databricks.

В следующем примере показан пример запроса и ответа. См. POST /api/2.0/lakeview/dashboards/migrate.

POST /api/2.0/lakeview/dashboards/migrate

Request body parameters:
{
  "source_dashboard_id": "4e443c27-9f61-4f2e-a12d-ea5668460bf1",
  "display_name": "Monthly Traffic Report",
  "parent_path": "/path/to/dir"
}

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 для извлечения сведений о панели мониторинга из черновика. В следующем примере запроса и ответа содержатся сведения о текущей версии черновика панели мониторинга в рабочей области.

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

GET /api/workspace/dashboards/list/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"
}

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

Ответ от 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