삭제¶
GET /api/v1/dashboard/{dashboard_uuid}/delete
개요¶
지정한 내장 뷰 및 관련 구성을 삭제합니다.
호출 전 및 사용 단계¶
내장 뷰 목록에서 UUID를 확인합니다. 복구가 필요하면 먼저 내장 뷰 내보내기를 수행하고, 내장 뷰 상세를 통해 바인딩 조건을 저장합니다. 이 GET 요청은 뷰와 관련 차트, 변수, 그룹 및 바인딩을 삭제하며, 해당 뷰를 참조하는 리포트에도 영향을 줄 수 있습니다. 대상을 확인한 후에만 요청을 수행합니다.
경로 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| dashboard_uuid | string | Y | 현재 워크스페이스의 내장 뷰 UUID입니다. 예: dsbd_inner_example가져오기 또는 입력 방법: 내장 뷰 목록의 content.data[].uuid에서 가져오거나, 생성 응답의 content.uuid를 사용할 수 있습니다. |
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
매개변수 추가 설명¶
반복 호출 시 대상이 존재하지 않는다는 응답이 반환될 수 있습니다. 시간 초과 후에는 먼저 목록을 확인하여 무작정 재시도하지 않도록 합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/dashboard/dsbd_inner_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 바로 확인할 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | array<string> |
삭제된 뷰 이름 배열입니다. |
{
"code": 200,
"content": [
"호스트 상세 내장 뷰"
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.NotFoundView | 대상이 없거나 삭제되었거나 이 워크스페이스에 속하지 않음 | 지정한 뷰를 찾을 수 없음 | 동일한 워크스페이스의 내장 뷰 목록에서 여전히 유효한 UUID를 가져옵니다. |
| 403 | ft.ForbiddenOperationResource | API Key에 대상 뷰에 대한 유효한 작업 권한이 없음 | 작업 권한 없음 | 워크스페이스 소속과 API Key 권한을 확인하거나 리소스 생성자에게 문의합니다. |
| 403 | ft.ForbiddenAccessResourceNoPublic | 비공개 뷰에 접근하는 ID와 뷰 생성 ID가 다름 | 리소스 접근 권한 없음, 현재 페이지가 비공개 상태 | 접근 권한이 있는 생성자가 작업하고, 동일한 워크스페이스의 API Key를 사용하는지 확인합니다. |