조회¶
GET /api/v1/dashboards/{dashboard_uuid}/get
개요¶
지정된 대시보드의 상세 정보, 차트 레이아웃 및 연관 정보를 읽습니다.
호출 전 준비 및 사용 단계¶
대시보드 목록에서 실제 대시보드 UUID를 가져옵니다. 응답의 UUID로 대상을 확인하고, extend, mapping 또는 태그 정보를 사용하여 다음 구성 업데이트를 준비합니다. 가져올 수 있는 전체 템플릿이 필요하면 내보내기 API를 사용합니다.
라우트 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 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를 가져옵니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.id | integer | 대시보드 레코드 번호입니다. |
| content.uuid | string | 대시보드 UUID이며, 상세 조회, 수정, 삭제 및 캐러셀에 사용됩니다. |
| content.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.name | string | 대시보드 표시 이름입니다. |
| content.desc | string | 대시보드 설명입니다. |
| content.identifier | string | 외부 사용자 지정 식별자이며 비어 있을 수 있습니다. |
| content.ownerType | string | 리소스 유형 소속이며, 대시보드는 일반적으로 node입니다. |
| content.type | string | 대시보드 유형이며 예: CUSTOM입니다. |
| content.chartPos | array<object> |
차트 레이아웃 배열입니다. 각 항목의 chartUUID는 차트 식별자이고 pos는 레이아웃 객체입니다. |
| content.chartPos[].chartUUID | string | 연결된 차트 UUID입니다. |
| content.chartPos[].pos | object | 차트 크기 및 위치이며 예: x, y, w, h입니다. |
| content.chartGroupPos | array<string> |
차트 그룹 식별자의 정렬 순서입니다. |
| content.iconSet | object | 아이콘 설정입니다. |
| content.isPublic | integer | 1 공개, 0 생성 주체만 표시, -1 사용자 지정 권한입니다. |
| content.extend | object | 확장 구성입니다. |
| content.mapping | array<object> |
변수 필드 매핑입니다. |
| content.createdWay | string | 리소스 생성 출처입니다. |
| content.dashboardBindSet | array | 뷰 바인딩 구성입니다. |
| content.openPermissionSet | boolean | 현재 사용자 지정 권한이 활성화되어 있는지 여부입니다. |
| content.permissionSet | array<string> |
작업 권한 주체 UUID 목록입니다. |
| content.readPermissionSet | array<string> |
읽기 권한 주체 UUID 목록입니다. |
| content.tagInfo | array<object> |
이 응답과 관련된 태그 정보입니다. |
| content.tagInfo[].id | string | 태그 식별자이며 uuid와 동일합니다. |
| content.tagInfo[].uuid | string | 태그 UUID입니다. |
| content.tagInfo[].name | string | 연결된 태그 이름입니다. |
| content.tagInfo[].description | string | 태그 설명입니다. |
| content.tagInfo[].colour | string | 태그 색상입니다. |
| content.tagInfo[].scope | array<string> |
태그의 적용 범위입니다. |
| content.tagInfo[].tagPermissionInfo | object | 태그 권한 부여가 있을 때 함께 제공되는 작업 및 읽기 권한 정보입니다. |
| content.status | integer | 레코드 상태입니다. |
| content.creator | string | 생성자 주체 ID입니다. |
| content.updator | string | 최근 수정자 주체 ID이며, 없을 경우 비어 있을 수 있습니다. |
| content.createAt | number | 생성 시간, Unix 초입니다. |
| content.updateAt | number | 최근 업데이트 시간, Unix 초입니다. 없을 경우 -1일 수 있습니다. |
| content.deleteAt | number | 삭제 시간, Unix 초입니다. 삭제되지 않은 경우 -1입니다. |
| content.creatorInfo | object | 생성자 정보이며 빈 객체일 수 있습니다. |
| content.updatorInfo | object | 최근 수정자 정보이며 빈 객체일 수 있습니다. |
| content.isFavorite | boolean | 현재 주체의 즐겨찾기 여부입니다. 상세 결과에서는 일반적으로 즐겨찾기한 경우에만 나타납니다. |
| content.isIndexDashboard | boolean | 현재 워크스페이스의 홈 대시보드인지 여부입니다. |
| content.refCheckerUUIDs | array<string> |
참조된 모니터 UUID입니다. |
| content.allow_operation | boolean 또는 null | 권한 계산 후의 작업 안내이며, 존재할 경우 편집 가능 여부를 판단하는 데 사용됩니다. |
| content.permissionSetInfo | object | 작업 권한 목록이 구성된 경우 UUID별로 주체 상세 정보를 반환합니다. |
| content.readPermissionSetInfo | object | 읽기 권한 목록이 구성된 경우 UUID별로 주체 상세 정보를 반환합니다. |
| content.extend.defaultTargetWorkspaceName | string | 기존 단일 기본 쿼리 공간 필드에 대응하는 표시 이름입니다. 상세 정보에서 제공될 수 있습니다. |
| content.extend.defaultTargetWorkspaceNames | array<string> |
기본 쿼리 공간 목록이 구성된 경우 해당 목록에 대응하는 표시 이름입니다. 상세 정보에서 제공될 수 있습니다. |
| content.declaration | object 또는 null | 워크스페이스의 공용 선언입니다. |
{
"code": 200,
"content": {
"id": 21,
"uuid": "dsbd_example",
"name": "운영 점검",
"desc": "운영 서비스 점검 지표",
"workspaceUUID": "wksp_example",
"identifier": "prod-check",
"ownerType": "node",
"type": "CUSTOM",
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"isPublic": 1,
"extend": {},
"mapping": [],
"createdWay": "manual",
"dashboardBindSet": [],
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"tagInfo": [],
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"status": 0,
"declaration": {},
"creatorInfo": {},
"updatorInfo": {},
"isIndexDashboard": false,
"refCheckerUUIDs": [],
"allow_operation": true
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방식 |
|---|---|---|---|---|
| 404 | ft.NotFoundView | 대상 대시보드가 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 없음 | 지정된 뷰를 찾을 수 없음 | 현재 공간 대시보드 목록에서 반환된 UUID로 변경하십시오. |
| 403 | ft.ForbiddenDashboardQueryOperation | 호출 주체에 대상 대시보드의 읽기 권한이 없음 | 대시보드【{}】 조회 권한이 없습니다 | 대상이 호출 주체에 읽기 권한을 개방했는지 확인하십시오. |