LLM 구성 목록 조회¶
GET /api/v1/llm_cfg/list
개요¶
LLM 애플리케이션과 집계 통계를 페이지 단위로 조회합니다.
호출 전 및 사용 단계¶
현재 Key 권한은 routine.defaultAccess 또는 llm.llmCfgManage 중 하나를 충족해야 하며, 현재 워크스페이스에만 적용됩니다. 내장 Agent 모니터링 애플리케이션은 이 그룹 목록에서 숨겨지고, 상세 조회 시 대상/내장 대상이 없으면 404를 반환합니다. 이 여섯 개 인터페이스로 전용 내장 애플리케이션을 관리해서는 안 됩니다. 공개 API는 appType 또는 크로스 워크스페이스 파라미터를 허용하지 않으며, 프런트엔드/AI 진입점의 추가 필터링과 응답 프로젝션을 그대로 적용할 수 없습니다.
목록/상세 조회는 Client Token을 평문으로 반환하며, 이는 수집 연동 자격 증명에 해당하므로 권한이 부여된 연동 측에만 전달해야 합니다. DF-API-KEY를 클라이언트 수집 Token으로 간주하지 마십시오. ifTokenExpired는 호환성을 위한 상태 힌트일 뿐이며, 동일 워크스페이스 소속/실제 사용 가능 여부를 증명할 수 없습니다. 목록에서는 레코드가 누락된 경우 오히려 false일 수 있으므로, 먼저 현재 워크스페이스의 활성 Token과 실제 수집을 확인하십시오.
content는 {data,declaration}을 유지하고, pageInfo는 최상위에 있으며, data 항목에 선언을 재귀적으로 추가하지 않습니다. 쿼리는 안정적인 정렬을 지정하지 않으므로 내장 항목을 생성/이름 변경/숨김 처리한 후 페이지 수가 달라질 수 있으며, totalCount와 표시 항목 수가 완전히 일치하지 않을 수 있다는 점을 감안해야 합니다. 통계는 appId가 아니라 현재 jsonContent.name을 기준으로 다운스트림 rollup과 매칭합니다. 이름을 변경했거나 수집 이름이 다르면 매칭되지 않을 수 있습니다. 기본값은 최근 24시간이며, JSON 문자열 timeRange로 통계 기간을 변경할 수 있습니다. 통계 실패/데이터 없음은 모두 null이며, 이 인터페이스가 조회 오류를 반환하지 않는다고 해서 0을 의미하지는 않습니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| pageIndex | int | 선택 사항, 생략 시 1, 클라이언트는 양의 정수 문자열을 전달해야 합니다. Query는 $type 강제 검증을 수행하지 않으므로 잘못된 텍스트 변환 시 500이 발생할 수 있습니다. null 허용: False 기본값: 1 예: 1획득 또는 입력 방법: 최상위 pageInfo에 따라 1부터 페이지를 나눕니다. |
|
| pageSize | int | 선택 사항, 생략 시 20. 기존 설명의 최대 100은 $maxValue/컨트롤러 절단과 대응하지 않으며, 현재 강제 상한을 보장하지 않으므로 클라이언트가 직접 제한해야 합니다. 0/음수를 전달하지 마십시오. null 허용: False 기본값: 20 예: 20획득 또는 입력 방법: 호출자가 페이지 크기를 제어하며 1–100을 권장합니다. |
|
| search | string | 선택 사항, 앞뒤 공백을 제거한 뒤 SQL ILIKE 퍼지 매칭을 수행합니다. %/_는 와일드카드 의미를 유지합니다. null 허용: False 예: 支付획득 또는 입력 방법: 애플리케이션 jsonContent.name을 기준으로 검색합니다. |
|
| timeRange | array | 선택 사항, 전송 형식은 [1785340800000,1785427200000]과 같습니다. 생략하거나 []이면 기본적으로 최근 24시간입니다. 현재 전체 길이/요소/순서 검증이 없으므로 두 개의 정수 밀리초 값이며 시작 < 종료임을 직접 보장해야 합니다. 잘못된 JSON은 406이 아니라 500이 발생할 수 있습니다. 동일한 이름의 Query를 여러 번 전달하는 방식이 아닙니다. null 허용: False 예: [1785340800000, 1785427200000]획득 또는 입력 방법: 호출자가 통계 시작/종료를 Unix 밀리초로 변환하고 URL 인코딩된 JSON 배열 문자열로 전달합니다. |
|
| type | string | 선택 사항, 정확한 유형, 생략 시 필터링하지 않습니다. 공개 열거형은 Langfuse뿐입니다. null 허용: False 선택 가능 값: ['Langfuse'] 예: Langfuse획득 또는 입력 방법: 현재 공개적으로 필터링 가능한 유형은 Langfuse입니다. |
파라미터 추가 설명¶
appId는 공개 애플리케이션 식별자이고 uuid는 그 호환 별칭입니다. 이 페이지의 실제 Token, 통계 및 오류 경계에 따라 사용하고, 프런트엔드/AI 인터페이스의 추가 파라미터를 그대로 적용하지 마십시오.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/llm_cfg/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 페이징 객체입니다. |
| content.data | array<object> |
현재 페이지의 애플리케이션으로, 평문 Token과 통계를 포함합니다. |
| content.data[].id | integer 또는 null | 데이터베이스 행 ID이며 경로 위치 지정에 사용되지 않습니다. 제출 전 스냅샷에서는 null일 수 있습니다. |
| content.data[].uuid | string | 공개 호환 별칭으로 appId와 같으며 내부 실제 LlmCfg UUID가 아닙니다. |
| content.data[].status | integer | 리소스 상태, 일반적으로 0, 소프트 삭제 3은 쿼리에서 제외됩니다. |
| content.data[].creator | string | 생성 주체 UUID, 현재 OpenAPI에서는 일반적으로 Key 리소스 wsak_입니다. |
| content.data[].updator | string | 최근 업데이트 주체, 업데이트되지 않은 경우 비어 있을 수 있습니다. |
| content.data[].createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.data[].updateAt | integer | Unix 초 단위 업데이트 시간, 업데이트되지 않은 경우 일반적으로 -1입니다. |
| content.data[].deleteAt | integer | Unix 초 단위 삭제 시간, 삭제되지 않은 경우 일반적으로 -1입니다. |
| content.data[].workspaceUUID | string | 현재 Key가 속한 워크스페이스입니다. |
| content.data[].appId | string | 공개 애플리케이션 ID, 기본적으로 llmcfg_ 접두사 값이 자동 생성됩니다. |
| content.data[].appType | string | 애플리케이션 계열 표시, 공개 생성 시 일반적으로 비어 있음; 기존 데이터는 llm/agent/obsyTeam 등일 수 있으나 이 공개 입력에서는 appType을 허용하지 않습니다. |
| content.data[].jsonContent | object | 애플리케이션 표시/연동 구성, 선언되지 않은 추가 최상위 하위 키를 포함하여 쓸 수 없습니다. |
| content.data[].jsonContent.name | string | 애플리케이션 표시 이름, 통계는 이 이름을 기준으로 매칭합니다. |
| content.data[].jsonContent.type | string | 공개 쓰기는 Langfuse만 가능; 기존 유형은 다를 수 있으나 공개적으로 다시 쓸 수 있음을 의미하지 않습니다. |
| content.data[].jsonContent.site | string | 선택적으로 저장되는 사이트 주소; 서버는 이 필드로 인해 타사 프로젝트를 자동 생성하거나 연결 가능 여부를 검증하지 않습니다. |
| content.data[].jsonContent.extend | object | 선택적 동적 확장 객체, 제공되지 않으면 키가 생략될 수 있습니다. |
| content.data[].jsonContent.extend.自定义键 | JSON | 원본 그대로 저장되는 JSON 값, 추가 실행/인증 구성을 보장하지 않습니다. |
| content.data[].clientToken | string | 목록/상세/생성 시 Client Token 평문; 수정 시 생략/빈 파라미터에는 내부 wctn_ UUID 호환 분기가 있으며 자세한 내용은 해당 페이지를 참조하십시오. |
| content.data[].ifTokenExpired | boolean | Token 상태 호환 힌트. 목록: 레코드가 존재하고 status3이면 true, 레코드가 없으면 오히려 false; 상세: 동일한 평문이 있는 삭제되지 않은 레코드가 하나라도 있는지로 판단합니다. false라도 현재 워크스페이스 Token이 수집 가능하거나 이미 적용되었음을 보장하지 않습니다. |
| content.data[].statisticalInfo | object | 다운스트림 집계 통계, jsonContent.name 기준 매칭; 데이터 없음, 비LLM 애플리케이션 또는 집계 이상 시 모두 null이므로 0으로 간주해서는 안 됩니다. |
| content.data[].statisticalInfo.callCount | number 또는 null | 기간 내 호출 수입니다. |
| content.data[].statisticalInfo.errorCount | number 또는 null | 기간 내 오류 수입니다. |
| content.data[].statisticalInfo.tokensCount | number 또는 null | 기간 내 Token 총량입니다. |
| content.data[].statisticalInfo.inputTokens | number 또는 null | 기간 입력 Token량입니다. |
| content.data[].statisticalInfo.outputTokens | number 또는 null | 기간 출력 Token량입니다. |
| content.data[].statisticalInfo.p50 | number 또는 null | 요청 지연 50분위, Studio는 집계 값을 그대로 전달하며 단위를 변환하지 않습니다. 사용 시 수집/집계 원본의 단위와 일치시켜야 합니다. |
| content.data[].statisticalInfo.p75 | number 또는 null | 요청 지연 75분위, p50과 동일한 단위 기준입니다. |
| pageInfo | object | 페이징 메타 정보, OpenAPI에서는 최상위에 위치; content는 객체를 유지합니다. |
| pageInfo.count | integer | 현재 페이지의 실제 항목 수입니다. |
| pageInfo.totalCount | integer | 구성 쿼리 페이징 총수; 후처리로 내장 이름 항목을 숨기면 총수와 표시 항목 수가 완전히 일치하지 않을 수 있습니다. |
| pageInfo.pageIndex | integer | 페이지 번호, 1부터 시작합니다. |
| pageInfo.pageSize | integer | 이번 요청의 페이지당 수량입니다. |
| content.declaration | object 또는 null | 현재 워크스페이스의 공통 선언; content 부모 객체에만 추가하며 data 항목에 재귀적으로 추가하지 않습니다. |
{
"code": 200,
"content": {
"data": [
{
"id": 7,
"uuid": "payment_llm",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"appId": "payment_llm",
"appType": "",
"jsonContent": {
"name": "支付助手",
"type": "Langfuse",
"site": "https://llm.example.com",
"extend": {
"team": "payment"
}
},
"clientToken": "<LLM-CLIENT-TOKEN>",
"ifTokenExpired": false,
"statisticalInfo": {
"callCount": null,
"errorCount": null,
"tokensCount": null,
"inputTokens": null,
"outputTokens": null,
"p50": null,
"p75": null
}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"count": 1,
"totalCount": 1,
"pageIndex": 1,
"pageSize": 20
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반한 경우 | 파라미터 파싱 실패 | Query 파라미터 표와 예시를 확인하십시오. |
| 500 | ft.InternalServerError | 데이터베이스 읽기, 기존 jsonContent/rollup 객체 형식, 잘못된 페이징 변환 또는 시간 범위 JSON 파싱 등 처리되지 않은 예외 | 내부 오류 | 파라미터와 기존 구성을 확인하고 traceId를 보존한 채 백오프하십시오. 통계가 모두 null인 경우에도 다운스트림을 사용할 수 없음을 의미할 수 있으므로 호출 수가 0이라고 해석해서는 안 됩니다. |