Поделиться через

Создание панелей мониторинга и управление ими с помощью API Lakeview

  • Статья

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

Необходимые компоненты

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

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

Получение панелей мониторинга SQL Databricks

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

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

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

GET /api/2.0/preview/sql/dashboards

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 to Lakeview , доступное в пользовательском интерфейсе. См . статью "Клонировать устаревшую панель мониторинга" на панель мониторинга Lakeview, чтобы узнать, как выполнять эту операцию с помощью пользовательского интерфейса Azure Databricks.

Идентификатор 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/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 предыдущий ответ, чтобы обновить новую панель мониторинга AI/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} , чтобы отправить черновик панели мониторинга в корзину. Панель мониторинга по-прежнему может быть восстановлена.

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

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

Примечание.

Чтобы выполнить постоянное удаление, используйте POST /api.2.0/workspace/delete

Следующие шаги