콘텐츠로 이동

목록 조회



GET /api/v1/viewer/list

개요

현재 워크스페이스에서 볼 수 있는 탐색기를 페이지 단위로 나열합니다.

호출 전 준비 및 사용 단계

이름, 태그, 필터 범위를 조합할 수 있습니다. 기본적으로 즐겨찾기를 먼저 나열한 후 업데이트 시간 내림차순으로 정렬합니다(업데이트 시간이 없으면 생성 시간 사용). sortKey를 명시적으로 지정하면 해당 필드로 정렬합니다. content.data[].uuid를 얻은 후 탐색기 상세를 조회할 수 있습니다. 결과가 없으면 목록이 비어 있습니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 파라미터

파라미터 이름 유형 필수 설명
sortKey string 생략하면 기본 정렬을 사용합니다. 필드를 명시적으로 선택하면 해당 필드로 정렬합니다.
null 허용: False
빈 문자열 허용: True
선택 가능한 값: ['name', 'updateAt']
예시: updateAt
획득 또는 입력 방법: 표시 필요에 따라 name 또는 updateAt 중에서 선택합니다.
sortMethod string 정렬 방향이며 기본값은 desc입니다.
null 허용: False
빈 문자열 허용: True
선택 가능한 값: ['desc', 'asc']
예시: desc
획득 또는 입력 방법: 오름차순은 asc, 내림차순은 desc를 전달합니다. 제어가 필요 없으면 생략합니다.
search string 이름 포함 일치로 검색하며, 생략하거나 공백이면 이름으로 필터링하지 않습니다.
null 허용: False
예시: 巡检
획득 또는 입력 방법: 기존 탐색기 이름에서 키워드를 선택합니다.
pageIndex integer 페이지 번호이며 기본값은 1입니다.
null 허용: False
$minValue: 1
예시: 1
획득 또는 입력 방법: 페이지는 1부터 시작합니다.
pageSize integer 페이지당 개수이며 기본값은 50이고 범위는 1~100입니다.
null 허용: False
$minValue: 1
$maxValue: 100
예시: 20
획득 또는 입력 방법: 페이지당 필요한 개수를 입력합니다.
filter string 기본값은 total입니다. total은 전체 표시, favorite는 즐겨찾기, import는 가져오기 소스, myCreate는 현재 ID가 생성한 항목, oftenBrowse는 최근 자주 본 항목(oftenBrowse는 ofenBrowse와 호환), selfVisibleOnly는 현재 ID의 비공개 탐색기입니다.
null 허용: False
선택 가능한 값: ['total', 'favorite', 'import', 'myCreate', 'oftenBrowse', 'ofenBrowse', 'selfVisibleOnly']
예시: total
획득 또는 입력 방법: 필요에 따라 파라미터 설명의 필터 값 중에서 선택합니다.
tagNames json 태그 이름 중 하나와 일치합니다.
null 허용: False
예시: ["team:ops"]
획득 또는 입력 방법: 상세의 content.tagInfo[].name에서 태그를 선택하여 JSON 문자열 배열로 구성하고 URL 인코딩합니다.

파라미터 추가 설명

페이지 정보는 응답 최상위에 있습니다. Query의 tagNames는 JSON 문자열 배열로 표현합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/viewer/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'search=巡检' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=20 \
  --data-urlencode sortKey=updateAt \
  --data-urlencode sortMethod=desc

응답

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 탐색기 리소스 소유 유형이며 일반적으로 viewer입니다.
content.data[].type string 탐색기 유형이며 예를 들어 CUSTOM입니다.
content.data[].isPublic integer 현재 리소스의 공개 범위입니다. 1은 공개, 0은 생성 ID만 볼 수 있습니다.
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[].extend object 탐색기 확장 정보입니다.
content.data[].mapping array<object> 변수 필드 매핑 정보입니다.
content.data[].dashboardBindSet array 뷰 바인딩 구성입니다.
content.data[].createdWay string 리소스 생성 소스입니다.
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 생성 ID 정보이며, 조회되지 않은 경우 빈 객체입니다.
content.data[].updatorInfo object 최근 업데이트 ID 정보이며, 조회되지 않은 경우 빈 객체입니다.
content.data[].creatorInfo.uuid string 해당 ID를 조회한 경우 제공될 수 있습니다. ID 식별자.
content.data[].creatorInfo.status integer 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 상태.
content.data[].creatorInfo.wsAccountStatus integer 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 멤버 상태.
content.data[].creatorInfo.username string 해당 ID를 조회한 경우 제공될 수 있습니다. 로그인 이름.
content.data[].creatorInfo.name string 해당 ID를 조회한 경우 제공될 수 있습니다. 표시 이름.
content.data[].creatorInfo.iconUrl string 해당 ID를 조회한 경우 제공될 수 있습니다. 아바타 URL.
content.data[].creatorInfo.email string 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 이메일. API Key ID인 경우 해당 식별자가 반환될 수 있습니다.
content.data[].creatorInfo.mobile string 해당 ID를 조회한 경우 제공될 수 있습니다. 연락처.
content.data[].creatorInfo.countryCode string 해당 ID를 조회한 경우 제공될 수 있습니다. 휴대폰 번호 국가 또는 지역 코드.
content.data[].creatorInfo.acntWsNickname string 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 내 닉네임.
content.data[].updatorInfo.uuid string 해당 ID를 조회한 경우 제공될 수 있습니다. ID 식별자.
content.data[].updatorInfo.status integer 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 상태.
content.data[].updatorInfo.wsAccountStatus integer 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 멤버 상태.
content.data[].updatorInfo.username string 해당 ID를 조회한 경우 제공될 수 있습니다. 로그인 이름.
content.data[].updatorInfo.name string 해당 ID를 조회한 경우 제공될 수 있습니다. 표시 이름.
content.data[].updatorInfo.iconUrl string 해당 ID를 조회한 경우 제공될 수 있습니다. 아바타 URL.
content.data[].updatorInfo.email string 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 이메일. API Key ID인 경우 해당 식별자가 반환될 수 있습니다.
content.data[].updatorInfo.mobile string 해당 ID를 조회한 경우 제공될 수 있습니다. 연락처.
content.data[].updatorInfo.countryCode string 해당 ID를 조회한 경우 제공될 수 있습니다. 휴대폰 번호 국가 또는 지역 코드.
content.data[].updatorInfo.acntWsNickname string 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 내 닉네임.
content.data[].isFavorite boolean 현재 ID의 즐겨찾기 상태입니다. 상세에서 즐겨찾기하지 않은 경우 반환되지 않을 수 있습니다.
content.data[].isIndexDashboard boolean 현재 워크스페이스의 홈 뷰인지 여부입니다.
content.data[].refCheckerUUIDs array<string> 연결된 모니터 식별자입니다.
content.declaration object 또는 null 워크스페이스의 공통 선언입니다.
pageInfo object 응답 최상위의 페이지 객체입니다.
pageInfo.pageIndex integer 현재 페이지 번호입니다.
pageInfo.pageSize integer 페이지당 개수입니다.
pageInfo.count integer 이 페이지의 항목 수입니다.
pageInfo.totalCount integer 일치하는 레코드 총수이며, 현재 구현에서는 빈 페이지일 때 0을 반환할 수 있습니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 25,
        "uuid": "dsbd_view_example",
        "name": "主机巡检查看器",
        "desc": "主机巡检与状态核对",
        "workspaceUUID": "wksp_example",
        "identifier": "",
        "ownerType": "viewer",
        "type": "CUSTOM",
        "isPublic": 1,
        "chartPos": [],
        "chartGroupPos": [],
        "iconSet": {},
        "extend": {},
        "mapping": [],
        "dashboardBindSet": [],
        "createdWay": "manual",
        "openPermissionSet": false,
        "permissionSet": [],
        "readPermissionSet": [],
        "tagInfo": [],
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "creatorInfo": {},
        "updatorInfo": {},
        "isFavorite": false,
        "isIndexDashboard": false,
        "refCheckerUUIDs": []
      }
    ],
    "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 배열 문자열을 전달하고, 페이지 번호가 정수인지 확인하며, 정렬 방식은 asc 또는 desc만 사용하세요.

문서 평가

이 페이지가 도움이 되었나요?