콘텐츠로 이동

조회



GET /api/v1/dashboard/carousel/{carousel_uuid}/get

개요

지정한 캐러셀 구성 및 대시보드 이름을 읽습니다.

호출 전 및 사용 단계

캐러셀 목록에서 캐러셀 UUID를 가져옵니다. 조회 시 유효하지 않은 대시보드 참조를 정리합니다. 과거의 만료된 참조가 있으면 이번 dashboardUUIDs에 여전히 이전 값이 포함될 수 있습니다. dashboardInfo를 기준으로 확인된 유효 대시보드를 사용하며, 다시 조회하면 정리된 목록을 확인할 수 있습니다.

경로 매개변수

매개변수명 유형 필수 설명
carousel_uuid string Y 캐러셀 구성 UUID입니다.
예: csel_example
가져오기 또는 입력 방법: 동일한 워크스페이스와 호출 ID에서 캐러셀 목록의 content[].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/carousel/csel_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.id integer 캐러셀 레코드의 내부 번호입니다.
content.uuid string 캐러셀 구성 UUID로, 상세 조회, 수정, 삭제에 사용합니다.
content.accountUUID string 캐러셀이 속한 호출 ID입니다.
content.workspaceUUID string 캐러셀이 속한 워크스페이스의 UUID입니다.
content.name string 캐러셀 이름입니다.
content.intervalTime string 저장된 캐러셀 간격 문자열입니다.
content.dashboardUUIDs array<string> 저장된 대시보드 UUID이며, 캐러셀 순서대로 정렬됩니다.
content.status integer 레코드 상태입니다.
content.createAt number 생성 시간, Unix 초입니다.
content.updateAt number 최근 업데이트 시간, Unix 초입니다. 업데이트가 없으면 -1입니다.
content.deleteAt number 삭제 시간, Unix 초입니다. 삭제되지 않았으면 -1입니다.
content.creator string 생성자 ID입니다.
content.updator string 최근 업데이트한 ID이며, 업데이트가 없으면 빈 문자열입니다.
content.declaration object 또는 null 워크스페이스의 공용 선언입니다.
content.dashboardInfo array<object> 캐러셀 순서대로 정렬됩니다. 각 항목은 단일 키 매핑이며, 키는 대시보드 UUID이고 값은 대시보드 이름입니다.
{
  "code": 200,
  "content": {
    "id": 10,
    "uuid": "csel_example",
    "accountUUID": "wsak_example",
    "workspaceUUID": "wksp_example",
    "name": "生产巡检轮播",
    "intervalTime": "30s",
    "dashboardUUIDs": [
      "dsbd_example"
    ],
    "status": 0,
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "creator": "wsak_example",
    "updator": "",
    "declaration": {},
    "dashboardInfo": [
      {
        "dsbd_example": "生产巡检"
      }
    ]
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
404 ft.DashboardCarouselObjectNotExist 구성이 삭제되었거나 존재하지 않거나 현재 호출 ID 및 워크스페이스에 속하지 않음 해당 캐러셀 객체가 존재하지 않습니다. 같은 Key로 캐러셀 목록에서 구성이 여전히 존재하는지 확인한 후 실제 UUID를 사용합니다.

문서 평가

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