목록 조회¶
GET /api/v1/dashboard/carousel/list
개요¶
현재 호출 주체가 워크스페이스 내에서 사용하는 캐러셀 구성을 나열합니다.
호출 전 및 사용 단계¶
생성 시 사용한 워크스페이스와 호출 주체로 조회합니다. 목록은 레코드 ID 내림차순으로 정렬되며 페이지네이션이 없습니다. 조회 시 구성에서 삭제되었거나 이 워크스페이스에 속하지 않는 대시보드 참조를 정리합니다. 결과의 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/carousel/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode 'search=점검'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | array<object> |
구성 목록입니다. 일치하는 레코드가 없으면 빈 배열입니다. |
| 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 | 워크스페이스의 공용 선언입니다. |
{
"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": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 | 파라미터 파싱 실패 | Query 파라미터 표 및 예시를 확인하십시오. |