Uso de api de panel para crear y administrar paneles

Artículo
02/12/2025

La API REST de Databricks incluye herramientas de administración específicas para administrar paneles de INTELIGENCIA ARTIFICIAL o BI. En este artículo se muestra cómo crear un nuevo panel de INTELIGENCIA ARTIFICIAL o BI a partir de un panel heredado existente. A continuación, muestra cómo usar herramientas de API para administrar el panel.

Nota:

Los paneles de IA/BI se conocían anteriormente como paneles de Lakeview. La API de Lakeview sigue conservando ese nombre.

Requisitos previos

Configure la autenticación para acceder a los recursos de Azure Databricks. Para obtener información sobre las opciones de autenticación y obtener instrucciones de configuración, consulte Autorización del acceso a los recursos de Azure Databricks.
Necesita las direcciones URL del área de trabajo a las que desea acceder. Consulte Nombres, direcciones URL e identificadores de instancias de áreas de trabajo.
Familiaridad con la referencia de la API de REST de Databricks.

Migrar un tablero de control

Puede crear un nuevo panel de INTELIGENCIA ARTIFICIAL o BI a partir de un panel heredado existente. El punto de conexión Migrar un panel de la API de Lakeview requiere source_dashboard_id. Opcionalmente, puede incluir un nombre para mostrar y una ruta de acceso en la que desea que se almacene el nuevo panel.

Obtención de paneles heredados

Para obtener source_dashboard_id, use la API de los paneles heredados para obtener una lista de todos los paneles del área de trabajo. Cada objeto de cuadro de mando de la lista de results incluye un UUID que puede utilizar para referirse al cuadro de mando heredado en los servicios de API REST de Azure Databricks.

En el ejemplo siguiente se muestra una solicitud de ejemplo y una respuesta para el punto de conexión Obtener objetos de panel. Se han omitido algunos detalles de respuesta para mayor claridad. Consulte GET /api/workspace/dashboards/list para obtener una descripción completa de este punto de conexión y la respuesta de ejemplo.

El UUID de un panel heredado es el id de nivel superior de la lista de objetos devueltos en results. En el caso de los paneles heredados, el UUID es similar a 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",
      ...
    }
  ]
}

Migrar el panel antiguo

Use el UUID asociado al panel heredado para crear una copia que se convierta automáticamente en un nuevo panel de INTELIGENCIA ARTIFICIAL o BI. Esto funciona como la herramienta Clonar en el panel de IA/BI disponible en la interfaz de usuario. Vea Clonar un panel heredado a un panel de IA/BI para aprender a realizar esta operación mediante la interfaz de usuario de Azure Databricks.

El UUID del panel heredado que desea convertir es necesario en el cuerpo de la solicitud. Opcionalmente, puede incluir un nuevo valor de display_name y un parent_path que identifique la ruta a la carpeta del área de trabajo donde desea almacenar el panel de control convertido.

La respuesta incluye un dashboard_id, el UUID del nuevo cuadro de mandos. El UUID de un panel de IA/BI es un valor alfanumérico de 32 dígitos, como 04aab30f99ea444490c10c85852f216c. Puede usarlo para identificar este panel dentro del espacio de nombres Lakeview y en distintos servicios de API REST de Azure Databricks.

En el ejemplo siguiente se muestra una solicitud y una respuesta de ejemplo. Consulte 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"
}

Obtener un panel borrador

Puede usar dashboard_id para extraer los detalles del panel de un panel borrador. La siguiente solicitud y respuesta de ejemplo incluye detalles sobre la versión actual del borrador del panel de control en el espacio de trabajo.

El campo etag realiza un seguimiento de la versión más reciente del panel. Puede usarlo para comprobar la versión antes de realizar actualizaciones adicionales.

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"
}

Actualización de un panel

Puede usar el dashboard_id en la respuesta anterior para actualizar el nuevo panel de INTELIGENCIA ARTIFICIAL o BI creado con esa operación. En el ejemplo siguiente se muestra una solicitud y una respuesta de ejemplo. El dashboard_id del ejemplo anterior se incluye como parámetro path.

Se han cambiado los códigos display_name y warehouse_id. El panel actualizado tiene un nuevo nombre y un almacenamiento predeterminado asignado, como se muestra en la respuesta. El campo etag es opcional. Si la versión especificada en el etag no coincide con la versión actual, se rechaza la actualización.

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"
}

Creación de un panel

Puede usar el punto de conexión Crear panel en la API de Lakeview para mover el panel entre áreas de trabajo. En el ejemplo siguiente se incluye un ejemplo de cuerpo de solicitud y una respuesta que crea un nuevo tablero. La clave serialized_dashboard del ejemplo anterior contiene todos los detalles necesarios para crear un panel de borrador duplicado.

El ejemplo incluye un nuevo valor de warehouse_id correspondiente a un almacén en el área de trabajo nueva. Consulte 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"
}

La única propiedad necesaria en el cuerpo de la solicitud es display_name. Esta herramienta puede copiar contenido del panel o crear paneles nuevos en blanco.

Publicación de un panel

Puede usar el punto de conexión Publicar panel para publicar un panel, establecer credenciales para visores e invalidar el warehouse_id establecido en el panel borrador. Debe incluir el UUID del panel como parámetro de ruta de acceso.

El cuerpo de la solicitud establece la propiedad embed_credentials en false. De manera predeterminada, embed_credentials se establece en true. La inserción de credenciales permite a los usuarios de nivel de cuenta ver los datos del panel. Consulte Publicar un panel. Se omite un nuevo valor warehouse_id, por lo que el panel publicado usa el mismo almacén asignado al panel de borrador.

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"
}

Obtener un panel publicado

La respuesta de GET /api/2.0/lakeview/dashboards/{dashboard_id}/published es similar a la respuesta proporcionada en el ejemplo anterior. El dashboard_id se incluye como parámetro de ruta.

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"
}

Anular la publicación de un panel

El panel borrador se conserva cuando se usa la API de Lakeview para anular la publicación de un panel. Esta solicitud elimina la versión publicada del panel.

En el ejemplo siguiente se usa el dashboard_id del ejemplo anterior. Una solicitud correcta produce un código de estado 200. No hay ningún cuerpo de respuesta.

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

Panel de papelera

Use DELETE /api/2.0/lakeview/dashboards/{dashboard_id} para enviar un panel borrador a la papelera. El panel todavía se puede recuperar.