Lakeview API를 사용하여 대시보드 만들기 및 관리
Lakeview API는 AI/BI 대시보드를 관리하기 위한 관리 도구를 제공합니다. 이 문서에서는 기존 레거시 대시보드에서 새 AI/BI 대시보드를 만드는 방법을 보여 줍니다. 그런 다음, Lakeview API를 사용하여 대시보드를 관리하는 방법을 보여줍니다.
필수 조건
- 작업 영역에 연결하려면 개인용 액세스 토큰이 필요합니다. Azure Databricks 개인용 액세스 토큰 인증을 참조하세요.
- 액세스하려는 작업 영역 URL이 필요합니다. 작업 영역 인스턴스 이름, URL 및 ID 참조
- Databricks REST API 참조에 대해 잘 알고 있습니다.
대시보드 마이그레이션
기존 레거시 대시보드에서 새 AI/BI 대시보드를 만들 수 있습니다. Lakeview API의 마이그레이션 대시보드 엔드포인트에는 다음이 source_dashboard_id
필요합니다. 필요에 따라 표시 이름과 새 대시보드를 저장할 경로를 포함할 수 있습니다.
Databricks SQL 대시보드 가져오기
이를 source_dashboard_id
얻으려면 Databricks SQL 대시보드 API를 사용하여 작업 영역의 모든 대시보드 목록을 가져옵니다. 목록의 results
각 대시보드 개체에는 Azure Databricks REST API 서비스에서 레거시 대시보드를 참조하는 데 사용할 수 있는 UUID가 포함되어 있습니다.
다음 예제에서는 대시보드 개체 가져오기 엔드포인트에 대한 샘플 요청 및 응답을 보여줍니다. 명확성을 위해 일부 응답 세부 정보는 생략되었습니다. 이 엔드포인트 및 샘플 응답에 대한 전체 설명은 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 대시보드로 자동으로 변환되는 복사본을 만듭니다. 이는 UI에서 사용할 수 있는 Lakeview 에 복제 도구처럼 작동합니다. Azure Databricks UI를 사용하여 이 작업을 수행하는 방법에 대한 자세한 내용은 Lakeview 대시보드에 레거시 대시보드 복제를 참조하세요.
변환하려는 레거시 대시보드의 UUID는 요청 본문에 필요합니다. 필요에 따라 변환된 대시보드를 저장할 폴더의 작업 영역 경로를 식별하는 새 display_name
값과 parent_path
해당 값을 포함할 수 있습니다.
응답에는 새 대시보드에 dashboard_id
대한 UUID가 포함됩니다. AI/BI 대시보드의 UUID는 다음과 같은 04aab30f99ea444490c10c85852f216c
32자리 영숫자 값입니다. 이를 사용하여 Lakeview 네임스페이스 및 다양한 Azure Databricks REST API 서비스에서 이 대시보드를 식별할 수 있습니다.
다음 예제에서는 샘플 요청 및 응답을 보여줍니다. 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"
}
대시보드 만들기
Lakeview API에서 대시보드 만들기 엔드포인트를 사용하여 작업 영역 간에 대시보드를 이동할 수 있습니다. 다음 예제에는 새 대시보드를 만드는 샘플 요청 본문 및 응답이 포함되어 있습니다. 이전 예제의 키에는 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를 경로 매개 변수로 포함해야 합니다.
요청 본문은 속성을 .로 false
설정합니다embed_credentials
. 기본적으로 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"
}
대시보드 게시 취소
초안 대시보드는 Lakeview API를 사용하여 대시보드를 게시 취소할 때 유지됩니다. 이 요청은 게시된 버전의 대시보드를 삭제합니다.
다음 예제에서는 이전 예제의 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를 사용합니다 .