사이트 목록¶
GET /api/v1/workspace/website/list
개요¶
현재 브랜드 구성의 사이트 표시 정보를 나열합니다.
호출 전 및 사용 단계¶
대상 워크스페이스에서 routine.defaultAccess 등 읽기 권한이 허용된 OpenAPI Key를 사용합니다. 현재 워크스페이스는 요청 헤더의 Key에서 가져오며, 이 엔드포인트에서 workspaceUUID를 전달하여 전환하지 않습니다.
Query/Body는 필요하지 않습니다. 이 OpenAPI 라우트는 파라미터를 공유 조회 메서드로 전달하지 않으므로, 프런트엔드/내부 엔드포인트의 type 인가 필터를 적용할 수 없습니다. 현재 브랜드 구성의 사이트를 반환하며, isOpen 또는 현재 워크스페이스의 권한 부여 여부로 항목별 필터링하지 않습니다. isCurSite는 현재 사이트 코드와 같은지만 나타내며, 조회 가능/권한 부여 완료를 의미하는 플래그가 아닙니다.
regionCode는 이후 교차 사이트 대상 선택에 사용됩니다. 먼저 조회 가능한 워크스페이스 목록과 함께 데이터 권한 부여를 확인합니다. endpoint는 사이트 콘솔 진입점이며, OpenAPI 또는 데이터 조회 서비스의 루트 주소로 직접 사용할 수 없습니다. regionName은 요청 컨텍스트 언어에 따라 사이트 이름을 가져오며, 누락 시 null일 수 있습니다. 사이트 구성이 없으면 []를 반환합니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
현재 환경에 구성된 사이트 정보를 반환합니다. content[*].regionCode는 query.targetRegion의 후보 사이트 코드로 사용할 수 있지만, 사이트가 존재한다고 해서 현재 워크스페이스에 해당 사이트의 데이터 액세스 권한이 부여된 것은 아닙니다.
query_data를 위해 교차 사이트 대상 워크스페이스와 targetRegion을 선택할 때는 /api/v1/wksp_share/granted_ws_list를 우선 호출하고, 대상 workspaceUUID와 동일한 그룹의 regionCode를 사용해야 합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/workspace/website/list' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | array<object> |
사이트 배열이며, 결과가 없으면 []입니다. |
| content[].regionCode | string | 사이트 코드입니다. 원래 문자열을 사용하며, 표시 이름을 코드로 사용하지 않습니다. |
| content[].regionName | string 또는 null | 현재 언어의 사이트 표시 이름이며, 비어 있거나 null일 수 있습니다. |
| content[].endpoint | string | 사이트 콘솔 구성 URL이며 비어 있을 수 있습니다. 범용 API Endpoint가 아닙니다. |
| content[].isCurSite | boolean | 현재 사이트인지 여부입니다. |
| content[].declaration | object | 비어 있지 않은 각 사이트 객체에 현재 워크스페이스의 공통 declaration을 추가합니다. |
{
"code": 200,
"content": [
{
"regionCode": "site_example",
"regionName": "예시 사이트",
"endpoint": "https://console.guance.com",
"isCurSite": true,
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 워크스페이스/사이트/권한 구성, 데이터베이스 또는 캐시 읽기 및 응답 포맷팅 실패 | 내부 오류 | traceId와 조회 조건을 보존하고, 재시도해도 계속 실패하면 관리자에게 구성을 확인하도록 요청합니다. 빈 결과를 근거로 사이트에 데이터가 없다고 추론해서는 안 됩니다. |