삭제¶
POST /api/v1/dashboards/{dashboard_uuid}/delete
개요¶
지정된 대시보드 및 관련 콘텐츠를 삭제합니다.
호출 전 및 사용 단계¶
먼저 대시보드 목록 또는 대시보드 상세에서 UUID를 확인합니다. 콘텐츠를 보존해야 하는 경우 먼저 템플릿을 내보냅니다. 삭제하면 차트, 변수, 메뉴 등 관련 항목이 정리되며 아카이브된 리포트에도 영향을 미칩니다. 시간 초과가 발생하면 먼저 대시보드가 여전히 존재하는지 확인한 후 다음 단계를 결정합니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| dashboard_uuid | string | Y | 대상 대시보드 UUID입니다. 예: dsbd_example가져오기 또는 입력 방법: 대시보드 목록의 content.data[].uuid에서 복사하거나 생성 결과의 content.uuid를 사용할 수도 있습니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
대상 UUID는 현재 워크스페이스 목록에서 가져옵니다. 삭제하기 전에 이 대시보드를 참조하는 애플리케이션과 리포트를 확인하십시오.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 삭제 성공 시 true입니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.NotFoundView | 대상 대시보드가 없거나, 삭제되었거나, 현재 워크스페이스에 속하지 않음 | 지정된 뷰를 찾을 수 없음 | 현재 워크스페이스의 대시보드 목록에서 반환된 UUID로 변경하십시오. |
| 403 | ft.ForbiddenDashboardOperation | 호출 주체가 대상 대시보드를 작업할 수 없음 | 대시보드【{}】에 대한 작업 권한이 없습니다 | 대시보드의 가시 범위, 작업 권한 부여 및 사용 중인 API Key를 확인하십시오. |