Skip to content

YAML template mode를 먼저 선택한 뒤 호출하는 API

YAML template mode를 먼저 선택한 뒤 호출하는 API입니다. 앱 이름, chart version, mode에 맞춰 선택된 tenant-values 템플릿에 필요한 config key, value type, section, validation rule 정보만 반환합니다.

HTTP 요청

http
GET https://<your-console-host>/api/v1/container/app-catalog/apps/{app_name}/config-schema

URI 매개변수

이름위치필수형식설명
app_namepath필수string앱 이름

쿼리 매개변수

이름필수형식설명
version필수stringTarget chart version
mode필수stringyaml-templates API에서 사용자가 선택한 YAML template mode. 값: standalone, single, ha
size선택stringyaml-templates API에서 사용자가 선택한 YAML template size. 값: default, small, medium, large
templateName선택string 또는 nulldeprecated: yaml-templates API에서 사용자가 선택한 tenant values 템플릿 파일명. 미전달 시 mode + size로 템플릿을 선택합니다.
deployable선택string 또는 nullapps/{appName}/{deployable}/helm 구조를 사용하는 경우 deployable 이름

요청 헤더

인증 헤더와 조직 헤더는 모든 API 가 같습니다. 공통 규약을 참고하십시오.

이 API 는 파티션 헤더(X-Partition-Id)를 사용하지 않습니다. 보내도 무시됩니다.

응답

상태 코드설명
200 OKconfig 입력 필드 schema
422 Unprocessable EntityValidation Error

위 표는 정상 응답과 요청 검증 실패만 나열합니다. 이 API 는 그 밖에 401(인증 실패) · 403(권한 없음) · 404(리소스 없음) · 502(인프라 오류)를 반환할 수 있습니다. 조건은 오류 처리를 참고하십시오.

응답 본문 — 200

이름필수형식설명
message선택string 또는 null응답 메시지
timestamp선택string응답 생성 시간
requestId필수string요청 식별자
result필수object결과 데이터
result.appName필수string앱 이름
result.version필수stringTarget chart version
result.mode필수string선택한 YAML template mode
result.size필수string선택한 YAML template size
result.templateName필수stringconfig schema 산출 기준 tenant values 템플릿 파일명
result.sourceTemplatePath필수stringconfig schema 산출 기준 tenant values 템플릿 경로
result.deployable선택string 또는 nulldeployable 이름
result.source필수objectschema source metadata
result.sections필수array (object)config form section 목록
result.fields필수array (object)input box 구성을 위한 key/type field 목록
result.formValidationRules선택array (object)form 단위 validation rule 목록

Thaki Cloud Aegis — 연동 개발자용 API 문서