조회¶
GET /api/v1/dashboard/{dashboard_uuid}/get
개요¶
지정한 내장 뷰의 설정, 차트 레이아웃 및 바인딩 조건을 조회합니다.
호출 전 및 사용 단계¶
먼저 내장 뷰 목록에서 UUID를 가져옵니다. 바인딩을 수정하고 유지해야 하는 경우 content.dashboardBidding을 먼저 읽고 저장합니다. 이식 가능한 템플릿 콘텐츠가 필요한 경우 내장 뷰 내보내기를 호출합니다.
라우트 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 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/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 | 내장 뷰 리소스 소유 유형이며, 내장 뷰는 inner입니다. |
| content.type | string | 내장 뷰 유형입니다(예: CUSTOM). |
| content.isPublic | integer | 상세 조회 범위입니다. 1은 공개, 0은 생성한 ID만 액세스할 수 있습니다. |
| 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.extend | object | 내장 뷰 확장 정보입니다. |
| content.mapping | array<object> |
변수 필드 매핑 정보입니다. |
| content.dashboardBindSet | array | 뷰 바인딩 설정입니다. |
| content.createdWay | string | 리소스 생성 출처입니다. |
| content.openPermissionSet | boolean | 엔터티 레코드의 권한 설정 스위치입니다. |
| content.permissionSet | array<string> |
레코드의 작업 권한 주체 UUID입니다. |
| content.readPermissionSet | array<string> |
레코드의 읽기 권한 주체 UUID입니다. |
| 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 | 생성 ID 정보이며, 조회되지 않으면 빈 객체입니다. |
| content.updatorInfo | object | 최근 업데이트 ID 정보이며, 조회되지 않으면 빈 객체입니다. |
| content.creatorInfo.uuid | string | 해당 ID가 조회되면 제공될 수 있습니다. ID 식별자입니다. |
| content.creatorInfo.status | integer | 해당 ID가 조회되면 제공될 수 있습니다. 계정 상태입니다. |
| content.creatorInfo.wsAccountStatus | integer | 해당 ID가 조회되면 제공될 수 있습니다. 워크스페이스 멤버 상태입니다. |
| content.creatorInfo.username | string | 해당 ID가 조회되면 제공될 수 있습니다. 로그인 이름입니다. |
| content.creatorInfo.name | string | 해당 ID가 조회되면 제공될 수 있습니다. 표시 이름입니다. |
| content.creatorInfo.iconUrl | string | 해당 ID가 조회되면 제공될 수 있습니다. 아바타 URL입니다. |
| content.creatorInfo.email | string | 해당 ID가 조회되면 제공될 수 있습니다. 계정 이메일입니다. API Key ID의 경우 해당 식별자가 반환될 수 있습니다. |
| content.creatorInfo.mobile | string | 해당 ID가 조회되면 제공될 수 있습니다. 연락처입니다. |
| content.creatorInfo.countryCode | string | 해당 ID가 조회되면 제공될 수 있습니다. 휴대폰 번호 국가 또는 지역 코드입니다. |
| content.creatorInfo.acntWsNickname | string | 해당 ID가 조회되면 제공될 수 있습니다. 워크스페이스 내 닉네임입니다. |
| content.updatorInfo.uuid | string | 해당 ID가 조회되면 제공될 수 있습니다. ID 식별자입니다. |
| content.updatorInfo.status | integer | 해당 ID가 조회되면 제공될 수 있습니다. 계정 상태입니다. |
| content.updatorInfo.wsAccountStatus | integer | 해당 ID가 조회되면 제공될 수 있습니다. 워크스페이스 멤버 상태입니다. |
| content.updatorInfo.username | string | 해당 ID가 조회되면 제공될 수 있습니다. 로그인 이름입니다. |
| content.updatorInfo.name | string | 해당 ID가 조회되면 제공될 수 있습니다. 표시 이름입니다. |
| content.updatorInfo.iconUrl | string | 해당 ID가 조회되면 제공될 수 있습니다. 아바타 URL입니다. |
| content.updatorInfo.email | string | 해당 ID가 조회되면 제공될 수 있습니다. 계정 이메일입니다. API Key ID의 경우 해당 식별자가 반환될 수 있습니다. |
| content.updatorInfo.mobile | string | 해당 ID가 조회되면 제공될 수 있습니다. 연락처입니다. |
| content.updatorInfo.countryCode | string | 해당 ID가 조회되면 제공될 수 있습니다. 휴대폰 번호 국가 또는 지역 코드입니다. |
| content.updatorInfo.acntWsNickname | string | 해당 ID가 조회되면 제공될 수 있습니다. 워크스페이스 내 닉네임입니다. |
| content.isIndexDashboard | boolean | 현재 ID에 대해 반환된 워크스페이스 홈 뷰인지 여부입니다. |
| content.refCheckerUUIDs | array<string> |
이 뷰와 연결된 모니터 UUID입니다. |
| content.dashboardBidding | object | 바인딩 조건 객체입니다. 바인딩이 없으면 빈 객체입니다. |
| content.dashboardBidding.* | array<object> |
실제 소스 필드로 구성된 매칭 조건 배열입니다. |
| content.dashboardBidding.*[].op | string | 매칭 연산자입니다. |
| content.dashboardBidding.*[].value | array<string> |
매칭 값 배열입니다. |
| content.tagInfo | array<object> |
내장 뷰는 현재 빈 배열을 반환합니다. |
| content.declaration | object 또는 null | 워크스페이스의 공개 선언입니다. |
{
"code": 200,
"content": {
"id": 72,
"uuid": "dsbd_inner_example",
"name": "호스트 상세 내장 뷰",
"desc": "호스트 기준으로 실행 상태 조회",
"workspaceUUID": "wksp_example",
"identifier": "host-overview",
"ownerType": "inner",
"type": "CUSTOM",
"isPublic": 1,
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"extend": {},
"mapping": [],
"dashboardBindSet": [],
"createdWay": "manual",
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"dashboardBidding": {
"host": [
{
"op": "in",
"value": [
"web-01"
]
}
]
},
"tagInfo": [],
"isIndexDashboard": false,
"refCheckerUUIDs": [],
"creatorInfo": {},
"updatorInfo": {},
"declaration": {}
},
"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와 다름 | 리소스 액세스 권한 없음, 현재 페이지가 비공개 상태 | 액세스 권한이 있는 생성 ID로 작업하고, 동일한 워크스페이스의 API Key를 사용하는지 확인합니다. |