조회¶
GET /api/v1/dashboards/list
개요¶
현재 호출 주체가 조회할 수 있는 대시보드를 페이지 단위로 나열합니다.
호출 전 준비 및 사용 단계¶
이름과 태그로 필터링할 수 있습니다. 기본적으로 현재 주체의 즐겨찾기 항목을 먼저 반환한 뒤 나머지 항목을 업데이트 시간 내림차순으로 정렬합니다. 업데이트 시간이 없는 레코드는 생성 시간을 사용합니다. 응답 항목의 uuid로 상세 조회, 수정, 내보내기 또는 삭제를 호출합니다. 빈 페이지는 data.length가 0인 경우 순회를 종료할 수 있습니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| search | string | 대시보드 이름에 대해 포함 일치를 수행하며, 생략하거나 공백이면 이름으로 필터링하지 않습니다. null 허용: False 예시: 巡检가져오기 또는 입력 방법: 기존 대시보드 이름에서 키워드를 복사합니다. |
|
| tagNames | json | 태그 이름 JSON 배열 문자열입니다. 여러 이름은 하나라도 일치하면 매칭됩니다. null 허용: False 예시: ["team:ops"]가져오기 또는 입력 방법: 대시보드 상세의 content.tagInfo[].name에서 값을 가져와 JSON 문자열 배열로 구성하고 URL 인코딩합니다. |
|
| pageIndex | integer | 페이지 번호이며 기본값은 1입니다. null 허용: False $minValue: 1 예시: 1가져오기 또는 입력 방법: 1부터 증가시키며 입력합니다. |
|
| pageSize | integer | 페이지당 레코드 수이며 기본값은 50이고 범위는 1~100입니다. null 허용: False $minValue: 1 $maxValue: 100 예시: 20가져오기 또는 입력 방법: 호출 필요에 따라 페이지당 건수를 입력합니다. |
파라미터 추가 설명¶
tagNames는 URL 인코딩된 JSON 문자열 배열을 받습니다. 페이지네이션 객체는 응답 최상위에 위치합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/dashboards/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode 'search=巡检' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.data | array<object> |
현재 페이지에서 조건에 맞고 조회 가능한 대시보드입니다. |
| content.data[].id | integer | 대시보드 레코드 번호입니다. |
| content.data[].uuid | string | 대시보드 UUID이며 상세 조회, 수정, 삭제 및 캐러셀에 사용됩니다. |
| content.data[].workspaceUUID | string | 소속 워크스페이스입니다. |
| content.data[].name | string | 대시보드 표시 이름입니다. |
| content.data[].desc | string | 대시보드 설명입니다. |
| content.data[].identifier | string | 외부 사용자 정의 식별자이며 비어 있을 수 있습니다. |
| content.data[].ownerType | string | 리소스 유형 소속이며, 대시보드는 일반적으로 node입니다. |
| content.data[].type | string | 대시보드 유형이며 예를 들면 CUSTOM입니다. |
| content.data[].chartPos | array<object> |
차트 레이아웃 배열입니다. 각 항목의 chartUUID는 차트 식별자이고 pos는 레이아웃 객체입니다. |
| content.data[].chartPos[].chartUUID | string | 이미 연결된 차트 UUID입니다. |
| content.data[].chartPos[].pos | object | 차트 크기 및 위치이며 예를 들면 x, y, w, h입니다. |
| content.data[].chartGroupPos | array<string> |
차트 그룹 식별자의 정렬 순서입니다. |
| content.data[].iconSet | object | 아이콘 설정입니다. |
| content.data[].isPublic | integer | 1은 공개, 0은 생성한 주체만 조회 가능, -1은 사용자 정의 권한입니다. |
| content.data[].extend | object | 확장 구성입니다. |
| content.data[].mapping | array<object> |
변수 필드 매핑입니다. |
| content.data[].createdWay | string | 리소스 생성 출처입니다. |
| content.data[].dashboardBindSet | array | 뷰 바인딩 설정입니다. |
| content.data[].openPermissionSet | boolean | 현재 사용자 정의 권한이 활성화되어 있는지 여부입니다. |
| content.data[].permissionSet | array<string> |
작업 권한 주체 UUID 목록입니다. |
| content.data[].readPermissionSet | array<string> |
읽기 권한 주체 UUID 목록입니다. |
| content.data[].tagInfo | array<object> |
본 응답과 관련된 태그 정보입니다. |
| content.data[].tagInfo[].id | string | 태그 식별자이며 uuid와 동일합니다. |
| content.data[].tagInfo[].uuid | string | 태그 UUID입니다. |
| content.data[].tagInfo[].name | string | 연결된 태그 이름입니다. |
| content.data[].tagInfo[].description | string | 태그 설명입니다. |
| content.data[].tagInfo[].colour | string | 태그 색상입니다. |
| content.data[].tagInfo[].scope | array<string> |
태그의 적용 범위입니다. |
| content.data[].tagInfo[].tagPermissionInfo | object | 태그 권한 부여가 존재할 때 작업 및 읽기 권한 정보가 함께 제공됩니다. |
| content.data[].status | integer | 레코드 상태입니다. |
| content.data[].creator | string | 생성자 주체 ID입니다. |
| content.data[].updator | string | 최근 업데이트한 주체 ID이며, 발생하지 않은 경우 비어 있을 수 있습니다. |
| content.data[].createAt | number | 생성 시간, Unix 초입니다. |
| content.data[].updateAt | number | 최근 업데이트 시간, Unix 초입니다. 발생하지 않은 경우 -1일 수 있습니다. |
| content.data[].deleteAt | number | 삭제 시간, Unix 초입니다. 삭제되지 않은 경우 -1입니다. |
| content.data[].creatorInfo | object | 생성자 정보이며 빈 객체일 수 있습니다. |
| content.data[].updatorInfo | object | 최근 업데이트한 주체 정보이며 빈 객체일 수 있습니다. |
| content.data[].isFavorite | boolean | 현재 주체의 즐겨찾기 여부입니다. 상세 결과에서는 일반적으로 즐겨찾기한 경우에만 나타납니다. |
| content.data[].isIndexDashboard | boolean | 현재 워크스페이스의 홈 대시보드 여부입니다. |
| content.data[].refCheckerUUIDs | array<string> |
참조된 모니터 UUID입니다. |
| content.data[].allow_operation | boolean 또는 null | 권한 계산 후의 작업 안내이며, 존재할 때 편집 가능 여부를 판단하는 데 사용됩니다. |
| content.data[].permissionSetInfo | object | 작업 권한 목록이 구성된 경우 UUID별로 주체 상세를 반환합니다. |
| content.data[].readPermissionSetInfo | object | 읽기 권한 목록이 구성된 경우 UUID별로 주체 상세를 반환합니다. |
| content.declaration | object 또는 null | 워크스페이스의 공개 선언입니다. |
| pageInfo | object | 응답 최상위의 페이지네이션 정보입니다. |
| pageInfo.pageIndex | integer | 현재 페이지 번호입니다. |
| pageInfo.pageSize | integer | 페이지당 건수입니다. |
| pageInfo.count | integer | 이 페이지의 건수입니다. |
| pageInfo.totalCount | integer | 일치하는 총 건수이며, 이 페이지에 결과가 없으면 현재 구현에서 0을 반환할 수 있습니다. |
{
"code": 200,
"content": {
"data": [
{
"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,
"creatorInfo": {},
"updatorInfo": {},
"isFavorite": false,
"isIndexDashboard": false,
"refCheckerUUIDs": [],
"allow_operation": true
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 | 파라미터 파싱 실패 | Query 파라미터 표 및 예시를 확인합니다. |
| 500 | ft.InternalServerError | tagNames를 JSON으로 파싱할 수 없거나 컨트롤러에서 페이지네이션 값을 정수로 변환할 수 없음 | 내부 오류 | URL 인코딩된 JSON 문자열 배열을 전달하고, 페이지 번호와 건수는 10진수 정수로 전달합니다. |