콘텐츠로 이동

목록 조회



GET /api/v1/dashboard/inner_list

개요

현재 워크스페이스에 이미 있는 사용자 내장 뷰를 나열합니다.

호출 전 및 사용 단계

이름으로 검색할 수 있으며, 결과는 레코드 번호 내림차순으로 반환되고 페이지네이션이 없습니다. content.data[].uuid로 내장 뷰 상세를 요청합니다. 조건에 맞는 뷰가 없으면 빈 목록을 반환합니다. 목록에는 설치되지 않은 시스템 템플릿이 별도로 나열되지 않습니다. 비공개 항목도 목록에 나타날 수 있으며, 상세 및 후속 작업은 여전히 해당 뷰의 권한 검사를 통과해야 합니다.

요청 헤더

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

Query 요청 파라미터

파라미터 이름 유형 필수 설명
search string 이름 포함 검색이며, 생략하거나 비어 있으면 이름으로 필터링하지 않습니다.
null 허용: False
예시: 主机
획득 또는 입력 방법: 검색할 내장 뷰 이름에서 키워드를 가져옵니다.

파라미터 추가 설명

바인딩 조건은 상세에서만 제공됩니다. 필터링 기준은 뷰 이름입니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/dashboard/inner_list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'search=主机'

응답

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 내장 뷰 리소스 소유권이며, 내장 뷰는 inner입니다.
content.data[].type string 내장 뷰 유형이며, 예를 들어 CUSTOM입니다.
content.data[].isPublic integer 상세 액세스 범위입니다. 1은 공개, 0은 생성 주체만 액세스 가능합니다.
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[].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[].innerTemplate object 또는 null 뷰 이름으로 시스템 내장 템플릿이 매칭되면 템플릿 요약이 포함됩니다.
content.data[].innerTemplate.uuid string 매칭된 시스템 템플릿 UUID입니다.
content.data[].innerTemplate.name string 시스템 템플릿 이름입니다.
content.data[].innerTemplate.path string 시스템 템플릿 경로입니다.
content.declaration object 또는 null 워크스페이스의 공통 선언입니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "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,
        "innerTemplate": null
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방식
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표 및 예시를 확인하세요.

문서 평가

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