목록¶
GET /api/v1/outer_function/list
개요¶
중앙 Func 서비스에서 OpenAPI를 통해 실행할 수 있는 함수 및 매개변수 메타데이터를 나열합니다.
호출 전 및 사용 단계¶
대상 워크스페이스 API Key를 사용하며 routine.defaultAccess 또는 anonymous.snapshotShared 중 하나의 진입점 권한이 필요합니다. 이 엔드포인트는 중앙 Func 서비스에서 category=openapi인 함수만 나열하며 기본적으로 로컬 Func 함수는 제외합니다. 선언되지 않은 isLocalFunction/funcSourceType/funcCategory/targetWorkspaceUUID 매개변수로 전환할 수 없습니다. 목록은 현재 허용된 후보 디렉터리이며 함수가 이미 호출되었음을 의미하지 않고, 코드 업로드 또는 함수 생성 인터페이스도 아닙니다.
먼저 함수 제목/스크립트/태그로 필터링한 다음 content[].id를 외부 함수 실행의 funcId로 읽습니다. name, scriptId 또는 url이 아닙니다. kwargsJSON/argsJSON/definition은 매개변수 정의와 기본값을 이해하는 데 사용되며, kwargsJSON의 정의 객체를 실제 매개변수 값으로 그대로 사용해서는 안 됩니다. description/함수 문서에 따라 실제 비즈니스 값을 입력해야 합니다. 목록은 페이지네이션하지 않고 네이티브 배열을 반환합니다. 원시 필드는 Func 버전에 따르며 제목과 설명은 요청 언어에 따라 현지화될 수 있습니다.
중앙 Func 목록/실행 전 허용 목록의 레거시 SDK 어댑테이션은 업스트림 HTTP 상태만으로 실패를 판단하지 않습니다. JSON 딕셔너리는 ok=false이거나 숫자 0인 경우에만 비즈니스 오류를 트리거하며, 200이 아니지만 ok가 누락되었거나 true이면 계속 data를 가져올 수 있습니다. 딕셔너리가 아니고 HTTP가 200이 아닌 경우에만 외부 함수 오류로 고정 보고합니다. 빈 디렉터리는 업스트림 서비스가 정상적으로 연결되었음을 단독으로 증명하지 않으므로, 이상 시 관리자는 서비스 로그와 함께 확인해야 합니다.
함수에 대한 자세한 설명은 Func 문서를 참고하십시오.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| _fuzzySearch | string | 선택적 문자열이며 현재 컨트롤러 매핑 시 폐기되어 이 엔드포인트에 실제 필터링 효과가 없습니다. null 허용: False 예시: 예시획득 또는 입력 방법: 이 레거시 필드는 현재 중앙 함수의 실제 필터링에 참여하지 않으며 funcTitle을 사용해야 합니다. |
|
| funcId | string | 선택 사항이며 중앙 Func id 조회 조건으로 사용되는 값으로, 스크립트 ID가 아닙니다. 예시는 실제 배포 환경에 존재하는지 기준으로 해야 합니다. null 허용: False 예시: example__openapi.test획득 또는 입력 방법: 이 인터페이스의 content[].id에서 실제 함수 ID를 가져옵니다. |
|
| funcScriptId | string | 선택적 문자열이며 중앙 Func의 scriptId로 매핑됩니다. 전체 funcId가 아닙니다. 예시: example__openapi획득 또는 입력 방법: 목록의 scriptId에서 함수 스크립트 집합 식별자를 가져옵니다. |
|
| funcTags | commaarray | 선택적 쉼표 목록 형식 문자열이며, 공개 유형 이름의 과거 표기는 commaarray입니다. 문자열로 중앙 Func에 전달되며, 태그 조합 의미는 해당 서비스에서 결정합니다. null 허용: False 예시: tag-a,tag-b획득 또는 입력 방법: 함수 메타데이터의 태그에서 이름을 선택하며, 전역 태그 UUID가 아닙니다. |
|
| funcTitle | string | 선택 사항이며 title 조건으로 중앙 Func에 전달됩니다. 일치 규칙은 Func 서비스에서 결정하며 로컬 데이터베이스의 LIKE와 완전히 동일하다고 보장하지 않습니다. null 허용: False 예시: 예시획득 또는 입력 방법: 목록의 title 또는 함수 용도에 따라 키워드를 선택합니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/outer_function/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode funcId=example__openapi.test
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | array | 네이티브 함수 메타데이터 배열이며 pageInfo가 없고 비어 있을 수 있습니다. |
| content[].id | string | 전체 함수 식별자이며 실행 funcId는 이 값을 사용합니다. |
| content[].name | string | 함수 짧은 이름이며 전체 id를 대신하지 않습니다. |
| content[].title | string | 표시 제목이며 언어에 따라 변경될 수 있습니다. |
| content[].description | string | 기능 및 매개변수 설명이며 언어에 따라 변경될 수 있습니다. |
| content[].category | string | 이 엔드포인트는 openapi 범주로 고정 필터링하며 실제 값은 중앙 Func에서 가져옵니다. |
| content[].definition | string | 함수 시그니처 및 매개변수 기본값 예시입니다. |
| content[].argsJSON | JSON | 위치 매개변수 정의이며 일반적으로 문자열 배열이고, 실제 메타데이터 형태는 Func 반환을 기준으로 합니다. |
| content[].kwargsJSON | JSON | 딕셔너리 매개변수 메타데이터/기본값 정의이며 직접 실행할 수 있는 매개변수 인스턴스가 아닙니다. |
| content[].scriptId | string | 스크립트 식별자이며 funcScriptId 필터링에 사용됩니다. |
| content[].url | string | Func 서비스 내부 실행 경로이며 Studio OpenAPI Endpoint가 아니므로 직접 연결하여 호출해서는 안 됩니다. |
| content[].isLocalFunction | boolean | 이 엔드포인트에서 중앙 함수 값은 false입니다. |
| content[].funcSourceType | string | 중앙 함수는 centre입니다. |
| content[].declaration | object 또는 null | 공용 워크스페이스 선언이며, 직접 배열의 비어 있지 않은 객체 행이 추가됩니다. |
| content[].기타 Func 메타데이터 필드 | JSON | 스크립트/통합/태그/확장 정보는 업스트림의 실제 반환을 따르며, 선언되지 않은 부분은 Studio에서 쓸 수 있는 필드로 간주할 수 없습니다. |
{
"code": 200,
"content": [
{
"id": "example__openapi.test",
"name": "test",
"title": "示例问候",
"description": "用于验证Func调用链的示例函数。",
"category": "openapi",
"definition": "test(workspace_uuid, workspace_token, your_name=\"OpenAPI User\")",
"argsJSON": [
"workspace_uuid",
"workspace_token",
"your_name"
],
"kwargsJSON": {
"workspace_uuid": {},
"workspace_token": {},
"your_name": {
"default": "OpenAPI User"
}
},
"scriptId": "example__openapi",
"url": "/api/v1/func/example__openapi.test",
"isLocalFunction": false,
"funcSourceType": "centre",
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공용 요청 오류는 공용 오류 정의를 참고하십시오.
중앙 Func 서비스에 의존하므로 로컬 Func/프런트엔드 호출 특유의 필드를 이 엔드포인트 계약으로 간주하지 않습니다. 서비스 오류 및 메타데이터 추가 키는 실제 버전을 기준으로 합니다.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 매개변수를 사용했거나 매개변수가 규칙을 위반함 | 매개변수 파싱 실패 | Query 매개변수 표 및 예시를 확인하십시오. |
| 400 | ft.OuterFuncFailed | 중앙 Func가 JSON 딕셔너리를 반환하고 ok=false이거나 숫자 0인 경우(특수 reason은 별도 매핑), 또는 딕셔너리가 아니고 HTTP가 200이 아닌 경우 | 외부 함수 호출 실패 | Func 서비스 연결 및 반환 message를 확인하고 traceId를 보존하십시오. 빈 목록과 요청 실패를 혼동하지 마십시오. |
| 500 | ft.InternalServerError | 연결 시간 초과/기타 네트워크 이상, 유효하지 않은 JSON 또는 메타데이터 구조 이상 | 내부 오류 | Func 서비스 주소/가용성을 확인하고 traceId를 보존하십시오. 시간 초과 오류는 이 엔드포인트에서 최종적으로 통합 500입니다. |
| 400 | ft.SameSetTraggerExists | 중앙 Func 목록/허용 목록이 ok=false를 반환하고 reason이 EBizCondition.DuplicatedCrontabConfig인 경우 | 동일한 구성의 트리거가 이미 존재함 | 이것은 공유 SDK의 특정 오류 매핑입니다. 업스트림 실제 응답과 구성을 확인하며, 이 페이지만으로 함수가 존재하지 않는다고 판단하지 마십시오. |