설정 항목

본 장에서는 각 모듈의 설정 항목들에 대해 설명합니다.

API 설정 항목

API의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
API ID *	API의 ID입니다. 이때 입력 조건은 다음과 같습니다. 32자 이하 영문자, 숫자, 특수문자(-, _, .)만 사용 가능
API Name *	API의 이름입니다. 이때 입력 조건은 다음과 같습니다. 32자 이하 영문자, 숫자, 특수문자(-, _, .)만 사용 가능
Description	API에 대한 간략한 설명입니다.
Gw Group Id *	API가 등록될 게이트웨이 그룹의 ID입니다.

항목

설명

API ID *

API의 ID입니다. 이때 입력 조건은 다음과 같습니다.

32자 이하
영문자, 숫자, 특수문자(-, _, .)만 사용 가능

API Name *

API의 이름입니다. 이때 입력 조건은 다음과 같습니다.

32자 이하
영문자, 숫자, 특수문자(-, _, .)만 사용 가능

Description

API에 대한 간략한 설명입니다.

Gw Group Id *

API가 등록될 게이트웨이 그룹의 ID입니다.

스테이지 설정 항목

스테이지의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Stage ID *	스테이지의 ID입니다. 이때 입력 조건은 다음과 같습니다. 고유한 값 영문자, 숫자, 특수문자(-, _, .)만 사용 가능
Stage Name *	스테이지의 이름입니다.
Stage Version	스테이지의 버전입니다.
Stage Basepath	스테이지의 기본 경로입니다. 이때 반드시 '/'로 시작해야 하며, URL 형식에 맞게 설정합니다.
Gw Group Id	API 게이트웨이 그룹의 ID입니다.
Description	스테이지에 대한 간략한 설명입니다.

항목

설명

Stage ID *

스테이지의 ID입니다. 이때 입력 조건은 다음과 같습니다.

고유한 값
영문자, 숫자, 특수문자(-, _, .)만 사용 가능

Stage Name *

스테이지의 이름입니다.

Stage Version

스테이지의 버전입니다.

Stage Basepath

스테이지의 기본 경로입니다. 이때 반드시 '/'로 시작해야 하며, URL 형식에 맞게 설정합니다.

Gw Group Id

API 게이트웨이 그룹의 ID입니다.

Description

스테이지에 대한 간략한 설명입니다.

스레드 풀 설정 항목

스레드 풀의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Thread Pool Id *	스레드 풀의 ID입니다.
Thread Pool Type	스레드 풀의 크기 조절 방식입니다. STATIC: 고정된 크기 유지 DYNAMIC: 게이트웨이 수에 따라 동적으로 크기 변경
Min Size *	스레드 풀에서 관리할 워커 스레드의 최소 개수입니다.
Max Size *	스레드 풀에서 관리할 워커 스레드의 최대 개수입니다.
Max Queue	작업 큐에서 대기할 수 있는 요청의 최대 개수입니다.

항목

설명

Thread Pool Id *

스레드 풀의 ID입니다.

Thread Pool Type

스레드 풀의 크기 조절 방식입니다.

STATIC: 고정된 크기 유지
DYNAMIC: 게이트웨이 수에 따라 동적으로 크기 변경

Min Size *

스레드 풀에서 관리할 워커 스레드의 최소 개수입니다.

Max Size *

스레드 풀에서 관리할 워커 스레드의 최대 개수입니다.

Max Queue

작업 큐에서 대기할 수 있는 요청의 최대 개수입니다.

트랜잭션 제한 설정 항목

리소스의 트랜잭션 제한 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Transaction Restriction Type *	트랜잭션 제한의 타입입니다.
Resources *	트랜잭션 제한을 적용할 리소스입니다. 이때 다중 선택이 가능합니다.
User Key	트랜잭션 제한이 동작될 사용자 키 입니다.
Activation *	트랜잭션 제한 활성화 여부입니다.
Restriction Period Type *	트랜잭션 제한의 동작 방식입니다. Immediate: 즉시 동작 Schedule: 사용자가 지정한 특정 기간 동안만 동작 Week: 사용자가 지정한 특정 요일의 특정 시간 동안만 동작
Error Message	트랜잭션 제한 동작 시 해당 리소스를 요청한 사용자에게 보여질 오류 메시지입니다.
Description	트랜잭션 제한에 대한 간략한 설명입니다.

항목

설명

Transaction Restriction Type *

트랜잭션 제한의 타입입니다.

Resources *

트랜잭션 제한을 적용할 리소스입니다. 이때 다중 선택이 가능합니다.

User Key

트랜잭션 제한이 동작될 사용자 키 입니다.

Activation *

트랜잭션 제한 활성화 여부입니다.

Restriction Period Type *

트랜잭션 제한의 동작 방식입니다.

Immediate: 즉시 동작
Schedule: 사용자가 지정한 특정 기간 동안만 동작
Week: 사용자가 지정한 특정 요일의 특정 시간 동안만 동작

Error Message

트랜잭션 제한 동작 시 해당 리소스를 요청한 사용자에게 보여질 오류 메시지입니다.

Description

트랜잭션 제한에 대한 간략한 설명입니다.

리소스 설정 항목

리소스의 기본 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Method *	API 호출에 사용할 메서드입니다.
Path *	리소스의 상위 경로입니다.
Description	리소스에 대한 간략한 설명입니다.
Redirect	리다이렉트 여부입니다.
Read Time Out Period(ms)	서버로부터 응답을 받을 수 있는 최대 대기 시간입니다. (기본값: 5000ms)
Remote IP Header	클라이언트 요청 메시지 헤더에 특정 필드 키 값을 지정하여, 어떤 IP에서 요청한 메시지인지 확인할 수 있습니다. (예: X-Forwarded-For)
Request Body Limit(Bytes)	클라이언트 요청 메시지 바디의 최대 사이즈를 지정하여 제한합니다.
Response Body Limit(Bytes)	엔드포인트 서버 응답 메시지 바디의 최대 사이즈를 지정하여 제한합니다.
Retry Count	요청이 실패하였을 때, 재시도 횟수를 나타냅니다.
Retry Interval(ms)	요청 재시도 대기 시간을 나타냅니다.
Thread Pool(Outbound)	게이트웨이와 엔드포인트 서버간 통신 프로세스 처리를 위한 스레드풀을 지정합니다.
Thread Pool(Inner biz)	게이트웨이 내부 프로세스 처리를 위한 스레드풀을 지정합니다.
Thread Pool Condition List	요청 메시지의 헤더 또는 쿼리 필드 값에 따라 프로세스를 처리할 특정 스레드풀을 지정합니다.
Default Thread Pool Enable	Thread Pool Condition List에서 조건을 추가하면 활성화 되는 항목으로, 설정한 조건에 따라 프로세스를 처리할 스레드풀을 Default 스레드풀로 지정할 지 여부를 나타냅니다.
Endpoint Type *	엔드포인트의 타입입니다. IP Server Group ProObject K8s
Scheme *	엔드포인트 서버의 프로토콜 타입입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Host Address *	엔드포인트 서버의 IP 주소입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Host Port *	엔드포인트 서버의 포트 번호입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Method *	엔드포인트 서버의 메서드입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Endpoint Value *	엔드포인트 서버 그룹입니다. [참고] 'Endpoint Type’이 'Server Group' 또는 'ProObject’일 경우 활성화
Proxy Path *	프록시 서버 경로입니다.
Auth Type *	인증 방식입니다. Api Key OAuth Terminal Auth User Key HMAC Custom Auth
Circuit Break *	서킷 브레이크 설정 방식입니다. none: 설정 안 함 global: 게이트웨이의 기본 설정값을 사용 custom: 리소스에서 개별적으로 적용 copy: 기존의 리소스 설정값을 복사하여 사용
Circuit Break Type *	서킷 브레이크 후처리 타입입니다. Service Open: 정해진 시간동안 서비스 요청을 받지 않음 Service Stop: 서비스 상태를 ON에서 OFF로 변경
Circuit Break Enable Error Code *	서킷 브레이크를 발생시킬 에러 조건으로 '에러 코드’의 활성화 여부입니다.
Circuit Break Enable Read Time Out *	서킷 브레이크를 발생시킬 에러 조건으로 'Read Timeout’의 활성화 여부입니다.
Circuit Break Enable Connection Time Out *	서킷 브레이크를 발생시킬 에러 조건으로 'Connection Timeout’의 활성화 여부입니다.
Circuit Break Fail Check *	서킷 브레이크의 발생 조건 타입입니다.
Circuit Break Fail Count *	서킷 브레이크를 발생시킬 에러의 발생 횟수입니다.
Circuit Break Fail Count Period *	서킷 브레이크 에러를 체크할 주기입니다.
Circuit Break Fail Percent(%) *	서킷 브레이크를 발생시킬 에러의 비율입니다. [참고] 'Circuit Break Fail Check’가 'Percent’일 경우 활성화
Circuit Break Recovery Policy *	서킷 브레이크가 Half Open 상태에서 정상 상태로 전환하기 위한 복구 정책의 타입입니다. Retry Time: Half Open 상태에서 첫 요청이 정상일 경우 복구 Pass Rate: Half Open 상태에서 일부 요청만을 에러 검증하여 이상이 없을 경우 복구
Circuit Break Retry Time Period *	서킷 브레이크 조건이 충족되었을 때 Half Open까지의 대기 시간입니다.
Circuit Break Recovery Rate	통과시킬 요청 건수와 검사할 총 요청 건수입니다. [참고] 'Circuit Break Recovery Policy’가 'Pass Rate’일 경우 활성화
Circuit Break Off Type *	서킷 브레이크가 동작하지 않는 시간 범위의 타입입니다.
Circuit Break Off Time Week Check *	서킷 브레이크가 동작하지 않는 요일입니다. [참고] 'Circuit Break Off Type’이 'custom’일 경우 활성화
Circuit Break Off Time *	서킷 브레이크가 동작하지 않는 시간 범위입니다. [참고] 'Circuit Break Off Type’이 'custom’일 경우 활성화

항목

설명

Method *

API 호출에 사용할 메서드입니다.

Path *

리소스의 상위 경로입니다.

Description

리소스에 대한 간략한 설명입니다.

Redirect

리다이렉트 여부입니다.

Read Time Out Period(ms)

서버로부터 응답을 받을 수 있는 최대 대기 시간입니다. (기본값: 5000ms)

Remote IP Header

클라이언트 요청 메시지 헤더에 특정 필드 키 값을 지정하여, 어떤 IP에서 요청한 메시지인지 확인할 수 있습니다. (예: X-Forwarded-For)

Request Body Limit(Bytes)

클라이언트 요청 메시지 바디의 최대 사이즈를 지정하여 제한합니다.

Response Body Limit(Bytes)

엔드포인트 서버 응답 메시지 바디의 최대 사이즈를 지정하여 제한합니다.

Retry Count

요청이 실패하였을 때, 재시도 횟수를 나타냅니다.

Retry Interval(ms)

요청 재시도 대기 시간을 나타냅니다.

Thread Pool(Outbound)

게이트웨이와 엔드포인트 서버간 통신 프로세스 처리를 위한 스레드풀을 지정합니다.

Thread Pool(Inner biz)

게이트웨이 내부 프로세스 처리를 위한 스레드풀을 지정합니다.

Thread Pool Condition List

요청 메시지의 헤더 또는 쿼리 필드 값에 따라 프로세스를 처리할 특정 스레드풀을 지정합니다.

Default Thread Pool Enable

Thread Pool Condition List에서 조건을 추가하면 활성화 되는 항목으로, 설정한 조건에 따라 프로세스를 처리할 스레드풀을 Default 스레드풀로 지정할 지 여부를 나타냅니다.

Endpoint Type *

엔드포인트의 타입입니다.

IP
Server Group
ProObject
K8s

Scheme *

엔드포인트 서버의 프로토콜 타입입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Host Address *

엔드포인트 서버의 IP 주소입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Host Port *

엔드포인트 서버의 포트 번호입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Method *

엔드포인트 서버의 메서드입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Endpoint Value *

엔드포인트 서버 그룹입니다.

[참고] 'Endpoint Type’이 'Server Group' 또는 'ProObject’일 경우 활성화

Proxy Path *

프록시 서버 경로입니다.

Auth Type *

인증 방식입니다.

Api Key
OAuth
Terminal Auth
User Key
HMAC
Custom Auth

Circuit Break *

서킷 브레이크 설정 방식입니다.

none: 설정 안 함
global: 게이트웨이의 기본 설정값을 사용
custom: 리소스에서 개별적으로 적용
copy: 기존의 리소스 설정값을 복사하여 사용

Circuit Break Type *

서킷 브레이크 후처리 타입입니다.

Service Open: 정해진 시간동안 서비스 요청을 받지 않음
Service Stop: 서비스 상태를 ON에서 OFF로 변경

Circuit Break Enable Error Code *

서킷 브레이크를 발생시킬 에러 조건으로 '에러 코드’의 활성화 여부입니다.

Circuit Break Enable Read Time Out *

서킷 브레이크를 발생시킬 에러 조건으로 'Read Timeout’의 활성화 여부입니다.

Circuit Break Enable Connection Time Out *

서킷 브레이크를 발생시킬 에러 조건으로 'Connection Timeout’의 활성화 여부입니다.

Circuit Break Fail Check *

서킷 브레이크의 발생 조건 타입입니다.

Circuit Break Fail Count *

서킷 브레이크를 발생시킬 에러의 발생 횟수입니다.

Circuit Break Fail Count Period *

서킷 브레이크 에러를 체크할 주기입니다.

Circuit Break Fail Percent(%) *

서킷 브레이크를 발생시킬 에러의 비율입니다.

[참고] 'Circuit Break Fail Check’가 'Percent’일 경우 활성화

Circuit Break Recovery Policy *

서킷 브레이크가 Half Open 상태에서 정상 상태로 전환하기 위한 복구 정책의 타입입니다.

Retry Time: Half Open 상태에서 첫 요청이 정상일 경우 복구
Pass Rate: Half Open 상태에서 일부 요청만을 에러 검증하여 이상이 없을 경우 복구

Circuit Break Retry Time Period *

서킷 브레이크 조건이 충족되었을 때 Half Open까지의 대기 시간입니다.

Circuit Break Recovery Rate

통과시킬 요청 건수와 검사할 총 요청 건수입니다.

[참고] 'Circuit Break Recovery Policy’가 'Pass Rate’일 경우 활성화

Circuit Break Off Type *

서킷 브레이크가 동작하지 않는 시간 범위의 타입입니다.

Circuit Break Off Time Week Check *

서킷 브레이크가 동작하지 않는 요일입니다.

[참고] 'Circuit Break Off Type’이 'custom’일 경우 활성화

Circuit Break Off Time *

서킷 브레이크가 동작하지 않는 시간 범위입니다.

[참고] 'Circuit Break Off Type’이 'custom’일 경우 활성화

CORS 설정 항목

CORS의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Enable CORS	CORS 기능의 활성화 여부입니다.
Access Control Allow Origin	현재 리소스 요청이 허용되는 출처입니다.
Access Control Allow Credentials	현재 리소스 요청에 자격 증명의 포함 여부입니다.
Access Control Allow Methods	서버가 허용하는 HTTP 메서드입니다.
Access Control Allow Headers	서버가 허용하는 HTTP 헤더입니다.
Access Control Max Age	Preflight 응답의 유효 기간입니다.
Access Control Expose Headers	클라이언트가 액세스할 수 있는 응답 헤더입니다.

항목

설명

Enable CORS

CORS 기능의 활성화 여부입니다.

Access Control Allow Origin

현재 리소스 요청이 허용되는 출처입니다.

Access Control Allow Credentials

현재 리소스 요청에 자격 증명의 포함 여부입니다.

Access Control Allow Methods

서버가 허용하는 HTTP 메서드입니다.

Access Control Allow Headers

서버가 허용하는 HTTP 헤더입니다.

Access Control Max Age

Preflight 응답의 유효 기간입니다.

Access Control Expose Headers

클라이언트가 액세스할 수 있는 응답 헤더입니다.

커스텀 에러 매핑 설정 항목

커스텀 에러 매핑의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Custom Error Mapping Name *	커스텀 에러 매핑의 이름입니다.
Gateway Error Code *	커스텀할 게이트웨이의 에러 코드입니다.
Description	커스텀 에러 매핑에 대한 간략한 설명입니다.
Use Error Mapping	기존 에러 매핑의 사용 여부입니다.
Error Mapping Id *	사용할 에러 매핑의 ID입니다. [참고] 'Use Error Mapping’이 'ON’일 경우 활성화
Response Status Code	게이트웨이의 에러 코드 발생 시 응답으로 전달될 코드입니다. [참고] 'Use Error Mapping’이 'OFF’일 경우 활성화
Response Header	게이트웨이의 에러 코드 발생 시 응답으로 전달될 헤더 파라미터입니다. 수정 모드 상태에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 파라미터가 추가됩니다. 이후 파라미터를 수정할 경우 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다. [참고] 'Use Error Mapping’이 'OFF’일 경우 활성화
Response Body	게이트웨이의 에러 코드 발생 시 응답으로 전달될 바디입니다. [참고] 'Use Error Mapping’이 'OFF’일 경우 활성화

항목

설명

Custom Error Mapping Name *

커스텀 에러 매핑의 이름입니다.

Gateway Error Code *

커스텀할 게이트웨이의 에러 코드입니다.

Description

커스텀 에러 매핑에 대한 간략한 설명입니다.

Use Error Mapping

기존 에러 매핑의 사용 여부입니다.

Error Mapping Id *

사용할 에러 매핑의 ID입니다.

[참고] 'Use Error Mapping’이 'ON’일 경우 활성화

Response Status Code

게이트웨이의 에러 코드 발생 시 응답으로 전달될 코드입니다.

[참고] 'Use Error Mapping’이 'OFF’일 경우 활성화

Response Header

게이트웨이의 에러 코드 발생 시 응답으로 전달될 헤더 파라미터입니다.

수정 모드 상태에서 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 파라미터가 추가됩니다. 이후 파라미터를 수정할 경우 figure response header edit icon 버튼을 클릭하고, 삭제할 경우 figure response header del icon 버튼을 클릭합니다.

[참고] 'Use Error Mapping’이 'OFF’일 경우 활성화

Response Body

게이트웨이의 에러 코드 발생 시 응답으로 전달될 바디입니다.

[참고] 'Use Error Mapping’이 'OFF’일 경우 활성화

동적 라우팅 설정 항목

동적 라우팅의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Priority *	동적 라우팅의 우선순위입니다. 순위가 낮을수록 먼저 적용됩니다.
Routing Name *	동적 라우팅의 이름입니다.
Description	동적 라우팅에 대한 간략한 설명입니다.
Condition	동적 라우팅의 조건입니다. 이때 타입으로 'header', 'body', 'query’를 지정할 수 있고, 해당하는 조건이 모두 충족될 경우 라우팅이 수행됩니다. 수정 모드 상태에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 파라미터가 추가됩니다. 이후 파라미터를 수정할 경우 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다.
Enable Endpoint	동적 라우팅 설정 정보 중 엔드포인트의 사용 여부입니다.
Enable Method Type	동적 라우팅 설정 정보 중 메서드의 사용 여부입니다.
Enable Path	동적 라우팅 설정 정보 중 프록시 서버 경로의 사용 여부입니다.
Endpoint Type *	엔드포인트의 타입입니다. [참고] 'Enable Endpoint’가 'ON’일 경우 활성화
Method *	엔드포인트 서버의 메서드입니다. [참고] 'Enable Method Type’이 'ON’일 경우 활성화
Proxy Path *	엔드포인트의 프록시 서버 경로입니다. [참고] 'Enable Path’가 'ON’일 경우 활성화

항목

설명

Priority *

동적 라우팅의 우선순위입니다. 순위가 낮을수록 먼저 적용됩니다.

Routing Name *

동적 라우팅의 이름입니다.

Description

동적 라우팅에 대한 간략한 설명입니다.

Condition

동적 라우팅의 조건입니다. 이때 타입으로 'header', 'body', 'query’를 지정할 수 있고, 해당하는 조건이 모두 충족될 경우 라우팅이 수행됩니다.

Enable Endpoint

동적 라우팅 설정 정보 중 엔드포인트의 사용 여부입니다.

Enable Method Type

동적 라우팅 설정 정보 중 메서드의 사용 여부입니다.

Enable Path

동적 라우팅 설정 정보 중 프록시 서버 경로의 사용 여부입니다.

Endpoint Type *

엔드포인트의 타입입니다.

[참고] 'Enable Endpoint’가 'ON’일 경우 활성화

Method *

엔드포인트 서버의 메서드입니다.

[참고] 'Enable Method Type’이 'ON’일 경우 활성화

Proxy Path *

엔드포인트의 프록시 서버 경로입니다.

[참고] 'Enable Path’가 'ON’일 경우 활성화

API 호출 경로 설정 항목

API 호출 경로의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
API Path *	API 호출을 위한 경로입니다.
Path Name *	경로의 이름입니다.

항목

설명

API Path *

API 호출을 위한 경로입니다.

Path Name *

경로의 이름입니다.

API 가변 호출 경로 설정

가변 호출 경로는 요청 URL의 일부를 변수로 처리하여, 여러 경로를 하나의 API로 처리할 수 있도록 하는 기능입니다. 가변 경로는 다음과 같이 두 가지 방식으로 설정할 수 있습니다.

단일 가변 경로: 경로의 한 단계만 가변 값으로 처리하는 방식으로, '와일드 카드 1개(*)' 또는 '{변수}' 형태로 지정합니다.
형식
```
/users/*
/users/{userid}
```
예시
```
/users/id, /users/name, /users/kim
```
/users/id/2, /users/name/lee, /users/kim/lee/pak 등은 매칭 되지 않습니다.
다중 가변 경로: 여러 단계의 하위 경로를 가변 값으로 처리하는 방식으로, '와일드 카드 2개(**)' 또는 '{변수+}' 형태로 지정합니다.
형식
```
/users/**
/users/{userid+}
```
예시
```
/users/id, /users/name, /users/kim, /users/id/2, /users/name/lee, /users/kim/lee/pak
```

가변 경로 사용 시 다음 제약 사항을 반드시 고려해야 합니다.

'단일 가변 경로’와 '다중 가변 경로’는 같은 depth의 경로마다 하나씩만 존재할 수 있습니다.
우선 순위는 일반 경로 > 단일 가변 경로 > 다중 가변 경로 입니다.
단일 가변 경로는 depth가 다르면 여러 개 사용이 가능하지만 다중 가변 경로는 마지막 경로에서만 사용 가능합니다.
사용 가능 예시
```
/users/{userid}/names/{username}/help
/job/{jobid}/*/create
/users/{userid}/names/**
```
사용 불가 예시
```
/users/{userid+}/help
/users/**/d/{test}
```

가변 값 전달 기능

가변 경로로 전달 받은 값은 리소스 Modulation 기능을 통해 엔드포인트 서버로 헤더나 쿼리 파라미터로 전달할 수 있습니다.

적용 방법

리소스 Modulation 화면에서 Request Header List Table 또는 Request Query List Table에 필드 추가시 Value 항목에 가변 경로 값 예약어를 입력합니다.
```
${parameter.<가변 경로명>}
```
예를 들어 /users/{userid} 사용시 ${parameter.userid}로 입력합니다. 이와 같이 설정한 경우, /users/kim 요청이 들어오면 Header 또는 Query에 지정한 필드 Key값의 Value로서 kim이 변환되어 추가됩니다.

메서드 설정 항목

메서드의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Api Method *	메서드의 종류입니다.
Description	메서드에 대한 간략한 설명입니다.
Endpoint Type *	엔드포인트의 타입입니다. IP Server Group ProObject K8s
Scheme *	엔드포인트 서버의 프로토콜 타입입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Host Address *	엔드포인트 서버의 IP 주소입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Host Port *	엔드포인트 서버의 포트 번호입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Method *	엔드포인트 서버의 메서드입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Endpoint Value *	엔드포인트 서버 그룹입니다. [참고] 'Endpoint Type’이 'Server Group' 또는 'ProObject’일 경우 활성화
Proxy Path *	프록시 서버 경로입니다.

항목

설명

Api Method *

메서드의 종류입니다.

Description

메서드에 대한 간략한 설명입니다.

Endpoint Type *

엔드포인트의 타입입니다.

IP
Server Group
ProObject
K8s

Scheme *

엔드포인트 서버의 프로토콜 타입입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Host Address *

엔드포인트 서버의 IP 주소입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Host Port *

엔드포인트 서버의 포트 번호입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Method *

엔드포인트 서버의 메서드입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Endpoint Value *

엔드포인트 서버 그룹입니다.

[참고] 'Endpoint Type’이 'Server Group' 또는 'ProObject’일 경우 활성화

Proxy Path *

프록시 서버 경로입니다.

Aggregation 설정 항목

Aggregation의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Method *	Aggregation API의 호출 메서드입니다.
Path *	Aggregation API의 호출 경로입니다.
Description	Aggregation API에 대한 간략한 설명입니다.

항목

설명

Method *

Aggregation API의 호출 메서드입니다.

Path *

Aggregation API의 호출 경로입니다.

Description

Aggregation API에 대한 간략한 설명입니다.

파라미터 설정 항목

요청 파라미터 설정 항목

요청 파라미터의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

헤더 파라미터

항목	설명
Header Parameter *	헤더 파라미터의 이름입니다.
Description	헤더 파라미터에 대한 간략한 설명입니다.
Data Type *	헤더 파라미터의 데이터 타입입니다.
Required	헤더 파라미터 값의 필수 여부입니다.

항목

설명

Header Parameter *

헤더 파라미터의 이름입니다.

Description

헤더 파라미터에 대한 간략한 설명입니다.

Data Type *

헤더 파라미터의 데이터 타입입니다.

Required

헤더 파라미터 값의 필수 여부입니다.

쿼리 파라미터

항목	설명
Query Parameter *	쿼리 파라미터의 이름입니다.
Description	쿼리 파라미터에 대한 간략한 설명을 입력합니다.
Data Type *	쿼리 파라미터의 데이터 타입입니다.
Required	쿼리 파라미터 값의 필수 여부입니다.
Array	쿼리 파라미터 값의 배열 형태 여부입니다.

항목

설명

Query Parameter *

쿼리 파라미터의 이름입니다.

Description

쿼리 파라미터에 대한 간략한 설명을 입력합니다.

Data Type *

쿼리 파라미터의 데이터 타입입니다.

Required

쿼리 파라미터 값의 필수 여부입니다.

Array

쿼리 파라미터 값의 배열 형태 여부입니다.

요청 바디 설정 항목

요청 바디의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Body Type	본문(body)의 타입입니다.
Body Converter Type	본문(body)을 최종적으로 변환할 타입입니다.

항목

설명

Body Type

본문(body)의 타입입니다.

Body Converter Type

본문(body)을 최종적으로 변환할 타입입니다.

응답 코드 설정 항목

응답 코드의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Response Code *	응답으로 받을 수 있는 코드입니다.
Description	응답 코드에 대한 간략한 설명입니다.

항목

설명

Response Code *

응답으로 받을 수 있는 코드입니다.

Description

응답 코드에 대한 간략한 설명입니다.

파라미터 변조 설정 항목

요청 헤더 설정 항목

요청 헤더 변조의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

Header

항목	설명
Key *	변환할 요청 헤더의 키값입니다.
Value *	변환될 실제 값입니다.
Filter *	변환 타입입니다. add: 헤더 추가 remove: 헤더 제거

항목

설명

Key *

변환할 요청 헤더의 키값입니다.

Value *

변환될 실제 값입니다.

Filter *

변환 타입입니다.

add: 헤더 추가
remove: 헤더 제거

요청 쿼리 설정 항목

요청 쿼리 변조의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

Query

항목	설명
Key *	변환할 요청 쿼리의 키값입니다.
Value *	변환될 실제 값입니다.
Filter *	변환 타입입니다. add: 쿼리 추가 remove: 쿼리 제거

항목

설명

Key *

변환할 요청 쿼리의 키값입니다.

Value *

변환될 실제 값입니다.

Filter *

변환 타입입니다.

add: 쿼리 추가
remove: 쿼리 제거

응답 헤더 설정 항목

응답 헤더 변조의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

Header

항목	설명
Key *	변환할 응답 헤더의 키값입니다.
Value *	변환될 실제 값입니다.
Filter *	변환 타입입니다. add: 헤더 추가 remove: 헤더 제거

항목

설명

Key *

변환할 응답 헤더의 키값입니다.

Value *

변환될 실제 값입니다.

Filter *

변환 타입입니다.

add: 헤더 추가
remove: 헤더 제거

Response Mapping Type

요청에 대한 응답의 전달 타입입니다.

항목	설명
instead	요청이 타깃 서버로 전달되지 않고, 즉시 헤더와 함께 응답을 클라이언트에게 돌려줍니다.
override	타깃 서버의 응답을 받은 후 그 응답을 수정하여 클라이언트에게 돌려줍니다.

항목

설명

instead

요청이 타깃 서버로 전달되지 않고, 즉시 헤더와 함께 응답을 클라이언트에게 돌려줍니다.

override

타깃 서버의 응답을 받은 후 그 응답을 수정하여 클라이언트에게 돌려줍니다.

서버 그룹 설정 항목

서버 그룹의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Server Group Id *	서버 그룹의 ID입니다. 이때 입력 조건은 다음과 같습니다. 고유한 값 영문자, 숫자, 특수문자(-, _, .)만 사용 가능
Server Group Name *	서버 그룹의 이름입니다.
Server Type *	서버 그룹에 포함될 서버의 타입입니다. IP: 서버를 'IP:Port' 형식으로 등록 K8s: 서버를 kubernetes로 등록 DNS: 서버를 도메인 이름으로 등록 anylink7: 서버를 AnyLink 7으로 등록 PO: 서버를 ProObject로 등록
Description	서버 그룹에 대한 간략한 설명입니다.
Server	서버 그룹에 포함될 서버의 정보입니다. Server ID: 서버의 ID Protocol: 서버와 통신을 위한 프로토콜 Ip: 서버의 IP 주소 Port: 서버의 포트 번호 Weight: 서버 그룹 내에서 서비스 콜의 비중을 표현하는 가중치 (1~1024까지 설정 가능) 수정 모드 상태에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 서버가 추가됩니다. 이후 서버를 수정할 경우 'Actions' 항목에서 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다.
Canary Settings > Recovery Time	카나리 배포나 Failover에 의해 중단된 엔드포인트가 복구되었을 때 일시적으로 가중치가 감소할 유예 시간입니다. (기본값: 0)
Canary Settings > Recovery Weight	유예 시간동안 감소될 가중치 비율입니다. (설정 범위: 0~1, 기본값: 0)

항목

설명

Server Group Id *

서버 그룹의 ID입니다. 이때 입력 조건은 다음과 같습니다.

고유한 값
영문자, 숫자, 특수문자(-, _, .)만 사용 가능

Server Group Name *

서버 그룹의 이름입니다.

Server Type *

서버 그룹에 포함될 서버의 타입입니다.

IP: 서버를 'IP:Port' 형식으로 등록
K8s: 서버를 kubernetes로 등록
DNS: 서버를 도메인 이름으로 등록
anylink7: 서버를 AnyLink 7으로 등록
PO: 서버를 ProObject로 등록

Description

서버 그룹에 대한 간략한 설명입니다.

Server

서버 그룹에 포함될 서버의 정보입니다.

Server ID: 서버의 ID
Protocol: 서버와 통신을 위한 프로토콜
Ip: 서버의 IP 주소
Port: 서버의 포트 번호
Weight: 서버 그룹 내에서 서비스 콜의 비중을 표현하는 가중치 (1~1024까지 설정 가능)

수정 모드 상태에서 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 서버가 추가됩니다. 이후 서버를 수정할 경우 'Actions' 항목에서 figure response header edit icon 버튼을 클릭하고, 삭제할 경우 figure response header del icon 버튼을 클릭합니다.

Canary Settings > Recovery Time

카나리 배포나 Failover에 의해 중단된 엔드포인트가 복구되었을 때 일시적으로 가중치가 감소할 유예 시간입니다. (기본값: 0)

Canary Settings > Recovery Weight

유예 시간동안 감소될 가중치 비율입니다. (설정 범위: 0~1, 기본값: 0)

서버 SSL 설정 항목

서버의 SSL 설정 항목에 대한 설명은 다음과 같습니다.

항목	세부 항목	설명
SSL Without Verify	-	서버 인증서의 유효성 검증 여부입니다.
CA 인증서 설정	인증서 위치	CA 인증서의 경로입니다.
인증서 타입	CA 인증서의 타입입니다. (PEM 타입만 가능)
클라이언트 인증서 설정	인증서 위치	클라이언트 인증서의 경로입니다.
인증서 타입	클라이언트 인증서의 타입입니다. (PEM 타입만 가능)
인증서 비밀번호	클라이언트 인증서의 비밀번호입니다.
Private Key 위치	개인 키의 경로입니다.
Private Key 비밀번호	개인 키의 비밀번호입니다.

항목

세부 항목

설명

SSL Without Verify

서버 인증서의 유효성 검증 여부입니다.

CA 인증서 설정

인증서 위치

CA 인증서의 경로입니다.

인증서 타입

CA 인증서의 타입입니다. (PEM 타입만 가능)

클라이언트 인증서 설정

인증서 위치

클라이언트 인증서의 경로입니다.

인증서 타입

클라이언트 인증서의 타입입니다. (PEM 타입만 가능)

인증서 비밀번호

클라이언트 인증서의 비밀번호입니다.

Private Key 위치

개인 키의 경로입니다.

Private Key 비밀번호

개인 키의 비밀번호입니다.

API 게이트웨이 그룹 설정 항목

Gateway Group Basic

API 게이트웨이 그룹의 기본 정보 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Gateway Group Id *	API 게이트웨이 그룹의 ID입니다.
Gateway Group Name *	API 게이트웨이 그룹의 이름입니다.
Description *	API 게이트웨이 그룹에 대한 간략한 설명입니다.

항목

설명

Gateway Group Id *

API 게이트웨이 그룹의 ID입니다.

Gateway Group Name *

API 게이트웨이 그룹의 이름입니다.

Description *

API 게이트웨이 그룹에 대한 간략한 설명입니다.

Gateway Group Detail

API 게이트웨이 그룹의 상세 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

Base Information

항목	설명
Min Thread Pool *	최소 스레드 풀 사이즈입니다. (기본값: 10)
Max Thread Pool *	최대 스레드 풀 사이즈입니다. (기본값: 100)
Max Queue Size *	최대 큐 사이즈입니다. (기본값: 1000)
Max Size (Request Byte Limit)	클라이언트 요청 메시지 바디의 최대 사이즈를 지정하여 제한합니다. (단위: Byte)
Connection Timeout *	엔드포인트 간 연결 시 소요되는 최대 시간입니다. (기본값: 30)
Read Timeout *	연결된 엔드포인트 간 데이터를 주고 받을 때 소요되는 최대 시간입니다. (기본값: 10)
Failover Timeout *	장애 조치에 소요되는 최대 시간입니다. (기본값: 10)
Failover Error Code *	'Failover Timeout’을 적용할 에러 코드 내용입니다.

항목

설명

Min Thread Pool *

최소 스레드 풀 사이즈입니다. (기본값: 10)

Max Thread Pool *

최대 스레드 풀 사이즈입니다. (기본값: 100)

Max Queue Size *

최대 큐 사이즈입니다. (기본값: 1000)

Max Size (Request Byte Limit)

클라이언트 요청 메시지 바디의 최대 사이즈를 지정하여 제한합니다. (단위: Byte)

Connection Timeout *

엔드포인트 간 연결 시 소요되는 최대 시간입니다. (기본값: 30)

Read Timeout *

연결된 엔드포인트 간 데이터를 주고 받을 때 소요되는 최대 시간입니다. (기본값: 10)

Failover Timeout *

장애 조치에 소요되는 최대 시간입니다. (기본값: 10)

Failover Error Code *

'Failover Timeout’을 적용할 에러 코드 내용입니다.

Access Log

항목	설명
Enable Access *	액세스 로그의 활성화 여부입니다.
Access Rotate Type *	액세스 로그 파일의 로테이션 타입입니다. TIMEBASE: 설정한 시간 주기로 로테이션 SIZE: 설정한 파일 크기를 초과할 시 로테이션
Access Rotate Parameter *	로테이션가 동작할 시간 주기 또는 파일 크기입니다.
Access Log File Name *	액세스 로그 데이터를 저장할 파일 이름입니다.
Access Log File Path *	액세스 로그 파일의 저장 경로입니다.
Log Time Zone *	액세스 로그에 표시될 시간 기준입니다.
Log Format *	액세스 로그의 포맷입니다.
Expiration Period *	액세스 로그의 만료 주기입니다.

항목

설명

Enable Access *

액세스 로그의 활성화 여부입니다.

Access Rotate Type *

액세스 로그 파일의 로테이션 타입입니다.

TIMEBASE: 설정한 시간 주기로 로테이션
SIZE: 설정한 파일 크기를 초과할 시 로테이션

Access Rotate Parameter *

로테이션가 동작할 시간 주기 또는 파일 크기입니다.

Access Log File Name *

액세스 로그 데이터를 저장할 파일 이름입니다.

Access Log File Path *

액세스 로그 파일의 저장 경로입니다.

Log Time Zone *

액세스 로그에 표시될 시간 기준입니다.

Log Format *

액세스 로그의 포맷입니다.

Expiration Period *

액세스 로그의 만료 주기입니다.

Circuit Break

항목	설명
Circuit Break Type *	서킷 브레이크 발생 시 서비스에 취해질 조치의 타입입니다. Service Open: 서킷 브레이크 조건이 만족할 때 해당 서비스는 Half Open 상태가 됩니다. 만약 이 기간 동안 복구 조건을 충족할 경우 다시 정상 서비스로 복구됩니다. Service Stop: 서킷 브레이크 조건을 만족할 때 해당 서비스는 Off 상태가 됩니다. 만약 다시 해당 서비스를 사용하려면 관리자가 수동으로 서비스를 활성화해야 합니다.
Enable Error Code *	서킷 브레이크를 발생시킬 에러 조건으로 '에러 코드’의 활성화 여부입니다.
Error Code *	서킷 브레이크 에러 조건으로 간주할 에러 코드입니다.
Enable Read timeout(ms) *	서킷 브레이크를 발생시킬 에러 조건으로 'Read Timeout’의 활성화 여부입니다.
Enable Connection Timeout(ms) *	서킷 브레이크를 발생시킬 에러 조건으로 'Connection Timeout’의 활성화 여부입니다.
Request Fail Check *	서킷 브레이크의 발생 조건 타입입니다.
Request Fail Count *	서킷 브레이크를 발생시킬 에러의 발생 횟수입니다.
Request Fail Period(ms) *	서킷 브레이크 에러를 체크할 주기입니다.
Recovery Policy *	서킷 브레이크가 Half Open 상태에서 정상 상태로 전환하기 위한 복구 정책의 타입입니다. Retry Time: Half Open 상태에서 첫 요청이 정상일 경우 복구 Pass Rate: Half Open 상태에서 일부 요청만을 에러 검증하여 이상이 없을 경우 복구
Retry Time Period(ms) *	서킷 브레이크 조건이 충족되었을 때 Half Open까지의 대기 시간입니다.
Circuit Break Off Time Week Check *	서킷 브레이크가 동작하지 않는 요일입니다.
Circuit Break Off Time *	서킷 브레이크가 동작하지 않는 시간 범위입니다.

항목

설명

Circuit Break Type *

서킷 브레이크 발생 시 서비스에 취해질 조치의 타입입니다.

Service Open: 서킷 브레이크 조건이 만족할 때 해당 서비스는 Half Open 상태가 됩니다. 만약 이 기간 동안 복구 조건을 충족할 경우 다시 정상 서비스로 복구됩니다.
Service Stop: 서킷 브레이크 조건을 만족할 때 해당 서비스는 Off 상태가 됩니다. 만약 다시 해당 서비스를 사용하려면 관리자가 수동으로 서비스를 활성화해야 합니다.

Enable Error Code *

서킷 브레이크를 발생시킬 에러 조건으로 '에러 코드’의 활성화 여부입니다.

Error Code *

서킷 브레이크 에러 조건으로 간주할 에러 코드입니다.

Enable Read timeout(ms) *

서킷 브레이크를 발생시킬 에러 조건으로 'Read Timeout’의 활성화 여부입니다.

Enable Connection Timeout(ms) *

서킷 브레이크를 발생시킬 에러 조건으로 'Connection Timeout’의 활성화 여부입니다.

Request Fail Check *

서킷 브레이크의 발생 조건 타입입니다.

Request Fail Count *

서킷 브레이크를 발생시킬 에러의 발생 횟수입니다.

Request Fail Period(ms) *

서킷 브레이크 에러를 체크할 주기입니다.

Recovery Policy *

서킷 브레이크가 Half Open 상태에서 정상 상태로 전환하기 위한 복구 정책의 타입입니다.

Retry Time: Half Open 상태에서 첫 요청이 정상일 경우 복구
Pass Rate: Half Open 상태에서 일부 요청만을 에러 검증하여 이상이 없을 경우 복구

Retry Time Period(ms) *

서킷 브레이크 조건이 충족되었을 때 Half Open까지의 대기 시간입니다.

Circuit Break Off Time Week Check *

서킷 브레이크가 동작하지 않는 요일입니다.

Circuit Break Off Time *

서킷 브레이크가 동작하지 않는 시간 범위입니다.

Monitoring

항목	설명
Monitoring Trace Enable *	모니터링 트레이스 데이터 생성 여부입니다.
Include Body *	트레이스의 속성으로 HTTP의 바디값 추가 여부입니다.
Encrypt Enable *	바디의 ES 내에서의 로그 데이터 암호화 여부입니다.
Interval(ms) *	모니터링 데이터의 송출 주기입니다.
Buffer Size(mb) *	span을 보관하는 버퍼의 크기입니다.
Endpoint *	모니터링 서버의 IP 주소와 포트 번호입니다.
gRPC Timeout	gRPC 네트워크에 대한 타임아웃입니다.
Response 4XX *	응답이 4XX인 경우에만 로그를 남길지 여부입니다.
Response 5XX *	응답이 5XX인 경우에만 로그를 남길지 여부입니다.
Latency Over(ms) *	응답의 지연 시간입니다. 응답 지연 시간이 설정값 이상인 span만 전송합니다.
Include Path	경로 이름입니다. 해당 경로를 포함한 요청의 span만 전송합니다.
File Enable *	로그 데이터를 파일로 저장할지 여부입니다.
File Name	로그 데이터를 저장할 파일의 이름입니다.
path	로그 데이터를 저장할 파일의 경로입니다.
Rotate Param	트레이스 로그 파일의 로테이션 조건으로 파일의 최대 크기입니다.
Rotate File Num	로테이션 기능 사용 시 만들어지는 파일의 최대 개수입니다.
Statistics Enable *	모니터링 통계 데이터의 생성 여부입니다.
Statistics Endpoint *	gRPC로 송출할 모니터링 서버의 엔드포인트입니다.
Statistics Histogram Bounds *	통계 데이터 타입 중 히스토그램의 영역입니다.
Statistics Interval *	통계 데이터의 송출 주기입니다. (설정 범위: 1000~60000)
gRPC Timeout	gRPC 네트워크에 대한 타임아웃입니다.

항목

설명

Monitoring Trace Enable *

모니터링 트레이스 데이터 생성 여부입니다.

Include Body *

트레이스의 속성으로 HTTP의 바디값 추가 여부입니다.

Encrypt Enable *

바디의 ES 내에서의 로그 데이터 암호화 여부입니다.

Interval(ms) *

모니터링 데이터의 송출 주기입니다.

Buffer Size(mb) *

span을 보관하는 버퍼의 크기입니다.

Endpoint *

모니터링 서버의 IP 주소와 포트 번호입니다.

gRPC Timeout

gRPC 네트워크에 대한 타임아웃입니다.

Response 4XX *

응답이 4XX인 경우에만 로그를 남길지 여부입니다.

Response 5XX *

응답이 5XX인 경우에만 로그를 남길지 여부입니다.

Latency Over(ms) *

응답의 지연 시간입니다. 응답 지연 시간이 설정값 이상인 span만 전송합니다.

Include Path

경로 이름입니다. 해당 경로를 포함한 요청의 span만 전송합니다.

File Enable *

로그 데이터를 파일로 저장할지 여부입니다.

File Name

로그 데이터를 저장할 파일의 이름입니다.

path

로그 데이터를 저장할 파일의 경로입니다.

Rotate Param

트레이스 로그 파일의 로테이션 조건으로 파일의 최대 크기입니다.

Rotate File Num

로테이션 기능 사용 시 만들어지는 파일의 최대 개수입니다.

Statistics Enable *

모니터링 통계 데이터의 생성 여부입니다.

Statistics Endpoint *

gRPC로 송출할 모니터링 서버의 엔드포인트입니다.

Statistics Histogram Bounds *

통계 데이터 타입 중 히스토그램의 영역입니다.

Statistics Interval *

통계 데이터의 송출 주기입니다. (설정 범위: 1000~60000)

gRPC Timeout

gRPC 네트워크에 대한 타임아웃입니다.

게이트웨이 설정 항목

게이트웨이의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Gateway Group Id	게이트웨이 그룹의 ID입니다.
Gateway Id	게이트웨이의 ID입니다.
Gateway Name	게이트웨이의 이름입니다.
IP	게이트웨이의 IP 주소입니다.
HTTP Port	게이트웨이의 HTTP 포트 번호입니다.
HTTPS Port	게이트웨이의 HTTPS 포트 번호입니다.
Description	게이트웨이에 대한 설명입니다.
Owner	게이트웨이를 등록한 사용자 이름입니다.

항목

설명

Gateway Group Id

게이트웨이 그룹의 ID입니다.

Gateway Id

게이트웨이의 ID입니다.

Gateway Name

게이트웨이의 이름입니다.

게이트웨이의 IP 주소입니다.

HTTP Port

게이트웨이의 HTTP 포트 번호입니다.

HTTPS Port

게이트웨이의 HTTPS 포트 번호입니다.

Description

게이트웨이에 대한 설명입니다.

Owner

게이트웨이를 등록한 사용자 이름입니다.

리스너 설정 항목

리스너의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Gateway Group Id *	배포할 게이트웨이 그룹 ID입니다.
Physical Name *	리스너의 이름입니다.
Protocol *	리스너가 사용할 프로토콜입니다.
Port *	리스너가 사용할 포트입니다.
Http Version *	리스너가 사용할 HTTP 버전입니다. HTTP/1.1: 항상 HTTP/1.1로 통신합니다. HTTP/2.0: 항상 HTTP/2.0로 통신합니다. HTTP/1.1 and HTTP/2.0: ALPN(Application Layer Protocol Negotiation)을 통해 HTTP 프로토콜을 판단합니다.
Idle Timeout *	설정한 시간동안 통신이 없다면 강제로 연결을 끊습니다. -1로 설정 시 동작하지 않습니다. (단위: ms)
Activated	리스너의 활성화 여부입니다.
Use SSL Passthrough *	받은 패킷을 그대로 바이패스하는 SSL Passthrough 기능 사용 여부입니다. [참고] 'Protocol’이 'Https’일 경우 활성화
Passthrough Target Type *	SSL Passthrough 사용 시 바이패스할 타깃 서버의 타입입니다. IP Server [참고] 'Use SSL Passthrough’가 'true’일 경우 활성화
Passthrough IP	SSL Passthrough 사용 시 바이패스할 서버의 IP입니다. [참고] 'Passthrough Target Type’이 'IP’일 경우 활성화
Passthrough Port	SSL Passthrough 사용 시 바이패스할 서버의 Port입니다. [참고] 'Passthrough Target Type’이 'IP’일 경우 활성화
Passthrough Server	SSL Passthrough 사용 시 바이패스할 서버 그룹입니다. [참고] 'Passthrough Target Type’이 'Server’일 경우 활성화
Client Auth Type *	클라이언트가 올바른지 판단하는 기능인 클라이언트 인증 기능을 설정합니다. None: 클라이언트 인증을 사용하지 않습니다. Want Client Auth: 클라이언트로부터 인증서를 요청하지만 인증서가 없어도 요청이 실패하지 않습니다. 이후 ${cert.serial_number} 예약어를 통해 요청받은 인증서의 시리얼 넘버를 매핑에 사용할 수 있습니다. Client Auth: 클라이언트로부터 인증서를 요청하며, 인증서가 존재하지 않으면 요청이 실패합니다. [참고] 'Protocol’이 'Https’일 경우 활성화
CA Certificate ID *	클라이언트 인증을 사용할시 사용할 CA 인증서 ID입니다. [참고] 'Client Auth Type’이 'Client Auth’일 경우 활성화
Server Certificate ID *	서버 인증서의 ID입니다. [참고] 'Protocol’이 'Https’일 경우 활성화
SNI	하나의 리스너로 여러 개의 호스트에 대해 다른 인증서를 사용할 수 있게 해주는 SNI 기능을 설정합니다. Server Name: SNI로 처리할 호스트 이름 Use SSL Passthrough: 받은 패킷을 그대로 바이패스하는 SSL Passthrough 기능의 사용 여부 Server Certificate ID: 서버 인증서의 ID 수정 모드에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 SNI가 추가됩니다. 이후 SNI를 수정할 경우 리스트에서 항목을 직접 클릭하고, 삭제할 경우 버튼을 클릭합니다. [참고] 'Protocol’이 'Https’일 경우 활성화

항목

설명

Gateway Group Id *

배포할 게이트웨이 그룹 ID입니다.

Physical Name *

리스너의 이름입니다.

Protocol *

리스너가 사용할 프로토콜입니다.

Port *

리스너가 사용할 포트입니다.

Http Version *

리스너가 사용할 HTTP 버전입니다.

HTTP/1.1: 항상 HTTP/1.1로 통신합니다.
HTTP/2.0: 항상 HTTP/2.0로 통신합니다.
HTTP/1.1 and HTTP/2.0: ALPN(Application Layer Protocol Negotiation)을 통해 HTTP 프로토콜을 판단합니다.

Idle Timeout *

설정한 시간동안 통신이 없다면 강제로 연결을 끊습니다. -1로 설정 시 동작하지 않습니다. (단위: ms)

Activated

리스너의 활성화 여부입니다.

Use SSL Passthrough *

받은 패킷을 그대로 바이패스하는 SSL Passthrough 기능 사용 여부입니다.

[참고] 'Protocol’이 'Https’일 경우 활성화

Passthrough Target Type *

SSL Passthrough 사용 시 바이패스할 타깃 서버의 타입입니다.

IP
Server

[참고] 'Use SSL Passthrough’가 'true’일 경우 활성화

Passthrough IP

SSL Passthrough 사용 시 바이패스할 서버의 IP입니다.

[참고] 'Passthrough Target Type’이 'IP’일 경우 활성화

Passthrough Port

SSL Passthrough 사용 시 바이패스할 서버의 Port입니다.

[참고] 'Passthrough Target Type’이 'IP’일 경우 활성화

Passthrough Server

SSL Passthrough 사용 시 바이패스할 서버 그룹입니다.

[참고] 'Passthrough Target Type’이 'Server’일 경우 활성화

Client Auth Type *

클라이언트가 올바른지 판단하는 기능인 클라이언트 인증 기능을 설정합니다.

None: 클라이언트 인증을 사용하지 않습니다.
Want Client Auth: 클라이언트로부터 인증서를 요청하지만 인증서가 없어도 요청이 실패하지 않습니다. 이후 ${cert.serial_number} 예약어를 통해 요청받은 인증서의 시리얼 넘버를 매핑에 사용할 수 있습니다.
Client Auth: 클라이언트로부터 인증서를 요청하며, 인증서가 존재하지 않으면 요청이 실패합니다.

[참고] 'Protocol’이 'Https’일 경우 활성화

CA Certificate ID *

클라이언트 인증을 사용할시 사용할 CA 인증서 ID입니다.

[참고] 'Client Auth Type’이 'Client Auth’일 경우 활성화

Server Certificate ID *

서버 인증서의 ID입니다.

[참고] 'Protocol’이 'Https’일 경우 활성화

SNI

하나의 리스너로 여러 개의 호스트에 대해 다른 인증서를 사용할 수 있게 해주는 SNI 기능을 설정합니다.

Server Name: SNI로 처리할 호스트 이름
Use SSL Passthrough: 받은 패킷을 그대로 바이패스하는 SSL Passthrough 기능의 사용 여부
Server Certificate ID: 서버 인증서의 ID

수정 모드에서 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 SNI가 추가됩니다. 이후 SNI를 수정할 경우 리스트에서 항목을 직접 클릭하고, 삭제할 경우 figure response header del icon 버튼을 클릭합니다.

[참고] 'Protocol’이 'Https’일 경우 활성화

인증서 설정 항목

인증서의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Gateway Group Id	배포될 게이트웨이 그룹 ID입니다.
Certificate Id *	인증서의 ID입니다.
Certificate Name *	인증서의 이름입니다.
Certificate Type *	인증서의 종류입니다. CA: 다른 인증서의 신뢰성을 증명하기 위한 CA 인증서입니다. Server: 서버의 신원을 증명하기 위한 서버 인증서입니다. Client: 사용자의 신원을 증명하기 위한 클라이언트 인증서입니다.
Input Method *	게이트웨이에 인증서를 배포하는 방식을 설정합니다. upload: 웹 브라우저를 통해 인증서를 업로드합니다. path: 게이트웨이 로컬에 저장된 인증서의 경로를 지정합니다. new: 인증 서버로부터 인증서를 발급합니다. 'Certificate Type’이 'Server’일 경우 선택 가능합니다. [참고] 'Input Method’를 'new’로 설정하면 인증 서버 및 도메인 서버 설정 항목과 인증서 발급에 필요한 항목이 나타납니다. 자세한 내용은 인증서 신규 발급 설정 항목 을 참고합니다.
Certificate File *	인증서 파일을 업로드합니다. [참고] 'Input Method’가 'upload’일 경우 활성화
Certificate Name *	업로드한 인증서 파일의 이름이 나타납니다. [참고] 'Input Method’가 'upload’일 경우 활성화
Certificate Path *	저장된 인증서의 경로입니다. [참고] 'Input Method’가 'path’일 경우 활성화
Key File	인증서의 키 파일을 업로드합니다. [참고] 'Certificate Type’이 'Server' 또는 'Client’이며, 'Input Method’가 'upload’일 경우 활성화
Key File Name	업로드한 키 파일의 이름이 나타납니다. [참고] 'Certificate Type’이 'Server' 또는 'Client’이며, 'Input Method’가 'upload’일 경우 활성화
Key File Path	저장된 키 파일의 경로입니다. [참고] 'Certificate Type’이 'Server' 또는 'Client’이며, 'Input Method’가 'path’일 경우 활성화
Key Password	키 파일에서 사용하는 패스워드입니다. [참고] 'Certificate Type’이 'Server' 또는 'Client’이며, 'Input Method’가 'upload' 또는 'path’일 경우 활성화
Description	인증서에 대한 간략한 설명입니다.

항목

설명

Gateway Group Id

배포될 게이트웨이 그룹 ID입니다.

Certificate Id *

인증서의 ID입니다.

Certificate Name *

인증서의 이름입니다.

Certificate Type *

인증서의 종류입니다.

CA: 다른 인증서의 신뢰성을 증명하기 위한 CA 인증서입니다.
Server: 서버의 신원을 증명하기 위한 서버 인증서입니다.
Client: 사용자의 신원을 증명하기 위한 클라이언트 인증서입니다.

Input Method *

게이트웨이에 인증서를 배포하는 방식을 설정합니다.

upload: 웹 브라우저를 통해 인증서를 업로드합니다.
path: 게이트웨이 로컬에 저장된 인증서의 경로를 지정합니다.
new: 인증 서버로부터 인증서를 발급합니다. 'Certificate Type’이 'Server’일 경우 선택 가능합니다.

[참고] 'Input Method’를 'new’로 설정하면 인증 서버 및 도메인 서버 설정 항목과 인증서 발급에 필요한 항목이 나타납니다. 자세한 내용은 인증서 신규 발급 설정 항목 을 참고합니다.

Certificate File *

인증서 파일을 업로드합니다.

[참고] 'Input Method’가 'upload’일 경우 활성화

Certificate Name *

업로드한 인증서 파일의 이름이 나타납니다.

[참고] 'Input Method’가 'upload’일 경우 활성화

Certificate Path *

저장된 인증서의 경로입니다.

[참고] 'Input Method’가 'path’일 경우 활성화

Key File

인증서의 키 파일을 업로드합니다.

[참고] 'Certificate Type’이 'Server' 또는 'Client’이며, 'Input Method’가 'upload’일 경우 활성화

Key File Name

업로드한 키 파일의 이름이 나타납니다.

[참고] 'Certificate Type’이 'Server' 또는 'Client’이며, 'Input Method’가 'upload’일 경우 활성화

Key File Path

저장된 키 파일의 경로입니다.

[참고] 'Certificate Type’이 'Server' 또는 'Client’이며, 'Input Method’가 'path’일 경우 활성화

Key Password

키 파일에서 사용하는 패스워드입니다.

[참고] 'Certificate Type’이 'Server' 또는 'Client’이며, 'Input Method’가 'upload' 또는 'path’일 경우 활성화

Description

인증서에 대한 간략한 설명입니다.

인증서 신규 발급 설정 항목

인증서 신규 발급 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
ACME Server URL *	인증서 발급 서버 주소입니다. (예: https://acme-staging-v02.api.letsencrypt.org/directory)
New Account URL	인증서 발급 서버의 계정 발급 주소입니다. 옵션 설정으로, 인증서 발급 기관이 유료 인증 기관인 경우 필요한 정보입니다. (예: https://acme-staging-v02.api.letsencrypt.org/acme/new-acct)
Account Email *	인증서 발급 정보 수신 이메일입니다.
Use External Account Binding *	유료 인증 기관에서 사전 계약을 통해 발급된 ID 및 HMAC Key 사용 여부를 나타냅니다. (기본값: false)
External Account ID *	'Use External Account Binding' 설정이 'true’인 경우 나타나며, 유료 인증 기관에서 발급된 ID를 설정합니다.
External Account HMAC Key *	'Use External Account Binding' 설정이 'true’인 경우 나타나며, 유료 인증 기관에서 발급된 HMAC Key를 설정합니다.
Common Name *	인증서를 발급할 기본 도메인명을 설정합니다. (예: example.com)
Subject Alt Names	인증서 발급 시 추가로 허용되는 도메인 이름 리스트입니다. (예: www.example.com, api.example.com)
Organization	인증서 정보에 포함될 조직명입니다.
Organizational Unit	인증서 정보에 포함될 부서명입니다.
Locality	인증서 정보에 포함될 도시명입니다.
State	인증서 정보에 포함될 시/도명입니다.
Country	인증서 정보에 포함될 국가 코드입니다.
Domain Server Host *	인증서 발급에 사용될 도메인이 연결된 실제 서버의 IP입니다.
Domain Server Port *	도메인 서버의 SSH 포트 번호입니다.
Domain Server User *	도메인 서버의 SSH 사용자 ID입니다.
Domain Server Password *	도메인 서버의 SSH 사용자 비밀번호입니다.
Account Key Password	발급 받은 인증서의 키 파일을 암호화할 때 사용될 비밀번호입니다.

항목

설명

ACME Server URL *

인증서 발급 서버 주소입니다.

(예: https://acme-staging-v02.api.letsencrypt.org/directory)

New Account URL

인증서 발급 서버의 계정 발급 주소입니다. 옵션 설정으로, 인증서 발급 기관이 유료 인증 기관인 경우 필요한 정보입니다.

(예: https://acme-staging-v02.api.letsencrypt.org/acme/new-acct)

Account Email *

인증서 발급 정보 수신 이메일입니다.

Use External Account Binding *

유료 인증 기관에서 사전 계약을 통해 발급된 ID 및 HMAC Key 사용 여부를 나타냅니다.

(기본값: false)

External Account ID *

'Use External Account Binding' 설정이 'true’인 경우 나타나며, 유료 인증 기관에서 발급된 ID를 설정합니다.

External Account HMAC Key *

'Use External Account Binding' 설정이 'true’인 경우 나타나며, 유료 인증 기관에서 발급된 HMAC Key를 설정합니다.

Common Name *

인증서를 발급할 기본 도메인명을 설정합니다.

(예: example.com)

Subject Alt Names

인증서 발급 시 추가로 허용되는 도메인 이름 리스트입니다.

(예: www.example.com, api.example.com)

Organization

인증서 정보에 포함될 조직명입니다.

Organizational Unit

인증서 정보에 포함될 부서명입니다.

Locality

인증서 정보에 포함될 도시명입니다.

State

인증서 정보에 포함될 시/도명입니다.

Country

인증서 정보에 포함될 국가 코드입니다.

Domain Server Host *

인증서 발급에 사용될 도메인이 연결된 실제 서버의 IP입니다.

Domain Server Port *

도메인 서버의 SSH 포트 번호입니다.

Domain Server User *

도메인 서버의 SSH 사용자 ID입니다.

Domain Server Password *

도메인 서버의 SSH 사용자 비밀번호입니다.

Account Key Password

발급 받은 인증서의 키 파일을 암호화할 때 사용될 비밀번호입니다.

인증서 신규 발급을 위해서는 인증 서버에서 접속 가능한 도메인이 필요합니다. 또한, 해당 도메인에 연결된 실제 서버에는 웹 서버(nginx, Apache 등) 설정에서 정적 리소스 응답 설정이 선행되어야 합니다.

예시

location ^~ /.well-known/acme-challenge/ {
            alias /home/{Domain Server User}/acme-challenge/;
            default_type "text/plain";
            try_files $uri =404;
    }

시스템 로그 설정 항목

시스템 로그 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Name *	시스템 로그의 이름입니다.
Log Level *	저장할 시스템 로그의 레벨입니다. 로그 레벨은 none < trace < debug < info < notice < warn < error < critical 순으로 높아집니다. [참고] 하위 레벨로 설정할수록 더 많은 로그가 저장되며, 선택한 레벨은 상위 레벨의 로그를 모두 포함합니다. 예를 들어 notice로 설정할 경우 notice, warn, error, critical 등급의 로그도 저장됩니다.
File Name *	해당 로그가 저장될 로그 파일의 이름입니다.
File Path *	로그 파일의 경로입니다.
System Rotate Type *	로그 파일의 로테이션 방식을 설정합니다. TIMEBASE: 설정 시간 주기에 따라 로그 파일을 분리합니다. SIZE: 설정한 파일 크기를 초과하면 로그 파일을 분리합니다.
System Rotate Parameter *	로그 로테이션이 동작할 시간 주기 또는 파일 크기입니다. TIMEBASE daily: 로그 파일을 매일 로테이션합니다. weekly: 로그 파일을 7일마다 로테이션합니다. monthly: 로그 파일을 30일마다 로테이션합니다. n minutes: 로그 파일을 n분마다 로테이션합니다. (n은 0보다 큰 정수) n hours: 로그 파일을 n시간마다 로테이션합니다. (n은 0보다 큰 정수) n days: 로그 파일을 n일마다 로테이션합니다. (n은 0보다 큰 정수) n weeks: 로그 파일을 n주마다 로테이션합니다. (n은 0보다 큰 정수) n months: 로그 파일을 n개월마다 로테이션합니다. (n은 0보다 큰 정수이며, 1개월은 30일 기준입니다.) SIZE n: 파일 크기가 n바이트를 초과하면 로그 파일을 로테이션합니다. n K: 파일 크기가 n킬로바이트를 초과하면 로그 파일을 로테이션합니다. n M: 파일 크기가 n메가바이트를 초과하면 로그 파일을 로테이션합니다.
Log Time Zone *	로그에 나타낼 시간 기준을 나타냅니다. (기본값: local) local: 로컬 시간 utc: 표준 시간
Compress *	로그 데이터 압축 여부입니다. (기본값: true)
Expiration Period *	로그 파일의 만료 주기입니다. (기본값: none) none: 로그 파일이 만료되지 않습니다. n seconds: n초 후에 로그 파일이 만료됩니다. n minutes: n분 후에 로그 파일이 만료됩니다. n hours: n시간 후에 로그 파일이 만료됩니다. n days: n일 후에 로그 파일이 만료됩니다. n weeks: n주 후에 로그 파일이 만료됩니다. n months: n개월 후에 로그 파일이 만료됩니다. (1개월은 30일 기준)
Log Format *	로그의 출력 포맷을 나타냅니다. (기본값: [%Y-%m-%d %L%H:%M:%S][%P][%q][%[THREAD]]-[%s][%O:%u]: %t) %[THREAD]: AnyAPI에서 동작중인 스레드 이름 %[GUID]: AnyAPI에서 현재 처리중인 거래에 대한 고유 ID %s: 메시지 소스 %t: 메시지 텍스트 %l: 메시지 우선순위 수준(1 .. 7) %p: 메시지 우선순위(치명적, 심각, 오류, 경고, 알림, 정보, 디버그, 추적) %q: 축약된 메시지 우선순위(F, C, E, W, N, I, D, T) %P: 메시지 프로세스 식별자 %T: 메시지 스레드 이름 %I: 메시지 스레드 식별자(숫자) %J: 메시지 스레드 OS 식별자(숫자) %N: 노드 또는 호스트 이름 %U: 메시지 소스 파일 경로(설정되지 않은 경우 빈 문자열) %O: 메시지 소스 파일 파일 이름(설정되지 않은 경우 빈 문자열) %u: 메시지 소스 줄 번호(설정되지 않은 경우 0) %w: 메시지 날짜/시간 축약된 요일(Mon, Tue, …) %W: 메시지 날짜/시간 전체 요일(월요일, 화요일, …) %b: 메시지 날짜/시간 약어 월(Jan, Feb, …) %B: 메시지 날짜/시간(1월, 2월, …) %d: 제로 패딩된 메시지 날짜/시간 날짜(01 ~ 31) %e: 메시지 날짜/시간 일(1 ~ 31) %f: 메시지 날짜/시간 공백이 추가된 날짜( 1 ~ 31) %m: 제로 패딩된 메시지 날짜/시간 월(01 ~ 12) %n: 메시지 날짜/시간 월(1 ~ 12) %o: 메시지 날짜/시간 공백이 추가된 월( 1 ~ 12) %y: 세기가 없는 메시지 날짜/시간 연도(70) %Y: 세기가 포함된 메시지 날짜/시간 연도(1970) %H: 메시지 날짜/시간 시간(00 ~ 23) %h: 메시지 날짜/시간 시간(00 ~ 12) %a: 메시지 날짜/시간 오전/오후(am/pm) %A: 메시지 날짜/시간 오전/오후(AM/PM) %M: 메시지 날짜/시간 분(00 ~ 59) %S: 메시지 날짜/시간 초(00 ~ 59) %i: 메시지 날짜/시간 밀리초(000 ~ 999) %c: 메시지 날짜/시간 100분의 1초(0 ~ 9) %F: 메시지 날짜/시간 소수 초/마이크로초(000000 ~ 999999) %z: ISO 8601 형식의 시간대 차이(Z 또는 +NN.NN) %Z: RFC 형식의 시간대 차이(GMT 또는 +NNNN) %L: 시간을 현지 시간으로 변환(날짜/시간 지정자 앞에 지정해야 하며 자체적으로는 아무것도 출력하지 않음) %E: 에포크 시간(UTC, 1970년 1월 1일 자정 이후의 초) %v[width]: 메시지 소스(%s)이지만 텍스트 길이가 '너비’로 채워지거나 잘립니다. %[name]: 주어진 이름을 가진 메시지 매개변수의 값 %%: 백분율 기호
Pretty Print *	JSON 형식의 로그 데이터를 JSON 포맷 형식으로 출력할지 여부입니다. (기본값: false)
Request/Response Header *	요청 및 응답 데이터의 헤더를 로그에 출력할지 여부입니다. (기본값: false)
Request/Response Body *	요청 및 응답 데이터의 바디를 로그에 출력할지 여부입니다. (기본값: false)
Component/Enable *	지정한 Component 관련 로그만 출력할지 여부입니다. (기본값: false)
Component *	Component/Enable이 'true’인 경우 활성화 되며, 복수의 Component를 선택할 수 있습니다. SYSTEM: 게이트웨이 부팅, 초기화 관련 로그 NETWORK: TCP, HTTP 프로세스 관련 로그 ENDPOINT: endpoint, endpointManager 동작 관련 로그 INGRESS: 내부로 유입되는 트래픽 데이터 로그 EGRESS: 외부로 나가는 트래픽 데이터 로그 SERVICE: 등록된 서비스 수행 시 (예: curlservice) 관련 로그 MONITORING: 모니터링 trace, metric 관련 로그 OVERVIEW: 거래 요약 로그로, 거래가 완료된 시점에 해당 거래 요약 정보 출력
Resource/Enable *	지정한 리소스 관련 로그만 출력할지 여부입니다.
Resource *	Resource/Enable이 'true’인 경우 활성화되며, 복수의 리소스를 선택할 수 있습니다.

항목

설명

Name *

시스템 로그의 이름입니다.

Log Level *

저장할 시스템 로그의 레벨입니다. 로그 레벨은 none < trace < debug < info < notice < warn < error < critical 순으로 높아집니다.

[참고] 하위 레벨로 설정할수록 더 많은 로그가 저장되며, 선택한 레벨은 상위 레벨의 로그를 모두 포함합니다. 예를 들어 notice로 설정할 경우 notice, warn, error, critical 등급의 로그도 저장됩니다.

File Name *

해당 로그가 저장될 로그 파일의 이름입니다.

File Path *

로그 파일의 경로입니다.

System Rotate Type *

로그 파일의 로테이션 방식을 설정합니다.

TIMEBASE: 설정 시간 주기에 따라 로그 파일을 분리합니다.
SIZE: 설정한 파일 크기를 초과하면 로그 파일을 분리합니다.

System Rotate Parameter *

로그 로테이션이 동작할 시간 주기 또는 파일 크기입니다.

TIMEBASE
- daily: 로그 파일을 매일 로테이션합니다.
- weekly: 로그 파일을 7일마다 로테이션합니다.
- monthly: 로그 파일을 30일마다 로테이션합니다.
- n minutes: 로그 파일을 n분마다 로테이션합니다. (n은 0보다 큰 정수)
- n hours: 로그 파일을 n시간마다 로테이션합니다. (n은 0보다 큰 정수)
- n days: 로그 파일을 n일마다 로테이션합니다. (n은 0보다 큰 정수)
- n weeks: 로그 파일을 n주마다 로테이션합니다. (n은 0보다 큰 정수)
- n months: 로그 파일을 n개월마다 로테이션합니다. (n은 0보다 큰 정수이며, 1개월은 30일 기준입니다.)
SIZE
- n: 파일 크기가 n바이트를 초과하면 로그 파일을 로테이션합니다.
- n K: 파일 크기가 n킬로바이트를 초과하면 로그 파일을 로테이션합니다.
- n M: 파일 크기가 n메가바이트를 초과하면 로그 파일을 로테이션합니다.

Log Time Zone *

로그에 나타낼 시간 기준을 나타냅니다. (기본값: local)

local: 로컬 시간
utc: 표준 시간

Compress *

로그 데이터 압축 여부입니다. (기본값: true)

Expiration Period *

로그 파일의 만료 주기입니다. (기본값: none)

none: 로그 파일이 만료되지 않습니다.
n seconds: n초 후에 로그 파일이 만료됩니다.
n minutes: n분 후에 로그 파일이 만료됩니다.
n hours: n시간 후에 로그 파일이 만료됩니다.
n days: n일 후에 로그 파일이 만료됩니다.
n weeks: n주 후에 로그 파일이 만료됩니다.
n months: n개월 후에 로그 파일이 만료됩니다. (1개월은 30일 기준)

Log Format *

로그의 출력 포맷을 나타냅니다. (기본값: [%Y-%m-%d %L%H:%M:%S][%P][%q][%[THREAD]]-[%s][%O:%u]: %t)

%[THREAD]: AnyAPI에서 동작중인 스레드 이름
%[GUID]: AnyAPI에서 현재 처리중인 거래에 대한 고유 ID
%s: 메시지 소스
%t: 메시지 텍스트
%l: 메시지 우선순위 수준(1 .. 7)
%p: 메시지 우선순위(치명적, 심각, 오류, 경고, 알림, 정보, 디버그, 추적)
%q: 축약된 메시지 우선순위(F, C, E, W, N, I, D, T)
%P: 메시지 프로세스 식별자
%T: 메시지 스레드 이름
%I: 메시지 스레드 식별자(숫자)
%J: 메시지 스레드 OS 식별자(숫자)
%N: 노드 또는 호스트 이름
%U: 메시지 소스 파일 경로(설정되지 않은 경우 빈 문자열)
%O: 메시지 소스 파일 파일 이름(설정되지 않은 경우 빈 문자열)
%u: 메시지 소스 줄 번호(설정되지 않은 경우 0)
%w: 메시지 날짜/시간 축약된 요일(Mon, Tue, …)
%W: 메시지 날짜/시간 전체 요일(월요일, 화요일, …)
%b: 메시지 날짜/시간 약어 월(Jan, Feb, …)
%B: 메시지 날짜/시간(1월, 2월, …)
%d: 제로 패딩된 메시지 날짜/시간 날짜(01 ~ 31)
%e: 메시지 날짜/시간 일(1 ~ 31)
%f: 메시지 날짜/시간 공백이 추가된 날짜( 1 ~ 31)
%m: 제로 패딩된 메시지 날짜/시간 월(01 ~ 12)
%n: 메시지 날짜/시간 월(1 ~ 12)
%o: 메시지 날짜/시간 공백이 추가된 월( 1 ~ 12)
%y: 세기가 없는 메시지 날짜/시간 연도(70)
%Y: 세기가 포함된 메시지 날짜/시간 연도(1970)
%H: 메시지 날짜/시간 시간(00 ~ 23)
%h: 메시지 날짜/시간 시간(00 ~ 12)
%a: 메시지 날짜/시간 오전/오후(am/pm)
%A: 메시지 날짜/시간 오전/오후(AM/PM)
%M: 메시지 날짜/시간 분(00 ~ 59)
%S: 메시지 날짜/시간 초(00 ~ 59)
%i: 메시지 날짜/시간 밀리초(000 ~ 999)
%c: 메시지 날짜/시간 100분의 1초(0 ~ 9)
%F: 메시지 날짜/시간 소수 초/마이크로초(000000 ~ 999999)
%z: ISO 8601 형식의 시간대 차이(Z 또는 +NN.NN)
%Z: RFC 형식의 시간대 차이(GMT 또는 +NNNN)
%L: 시간을 현지 시간으로 변환(날짜/시간 지정자 앞에 지정해야 하며 자체적으로는 아무것도 출력하지 않음)
%E: 에포크 시간(UTC, 1970년 1월 1일 자정 이후의 초)
%v[width]: 메시지 소스(%s)이지만 텍스트 길이가 '너비’로 채워지거나 잘립니다.
%[name]: 주어진 이름을 가진 메시지 매개변수의 값
%%: 백분율 기호

Pretty Print *

JSON 형식의 로그 데이터를 JSON 포맷 형식으로 출력할지 여부입니다. (기본값: false)

Request/Response Header *

요청 및 응답 데이터의 헤더를 로그에 출력할지 여부입니다. (기본값: false)

Request/Response Body *

요청 및 응답 데이터의 바디를 로그에 출력할지 여부입니다. (기본값: false)

Component/Enable *

지정한 Component 관련 로그만 출력할지 여부입니다. (기본값: false)

Component *

Component/Enable이 'true’인 경우 활성화 되며, 복수의 Component를 선택할 수 있습니다.

SYSTEM: 게이트웨이 부팅, 초기화 관련 로그
NETWORK: TCP, HTTP 프로세스 관련 로그
ENDPOINT: endpoint, endpointManager 동작 관련 로그
INGRESS: 내부로 유입되는 트래픽 데이터 로그
EGRESS: 외부로 나가는 트래픽 데이터 로그
SERVICE: 등록된 서비스 수행 시 (예: curlservice) 관련 로그
MONITORING: 모니터링 trace, metric 관련 로그
OVERVIEW: 거래 요약 로그로, 거래가 완료된 시점에 해당 거래 요약 정보 출력

Resource/Enable *

지정한 리소스 관련 로그만 출력할지 여부입니다.

Resource *

Resource/Enable이 'true’인 경우 활성화되며, 복수의 리소스를 선택할 수 있습니다.

API 키 설정 항목

API 키의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Key Name *	API 키의 이름입니다. 입력 조건은 다음과 같습니다. 고유한 값 영문자, 숫자, 특수문자(-, _, .)만 사용 가능
Key Type	API 키 값의 생성 방식입니다. Auto Generate: 자동 생성 Custom: 사용자가 보유한 키 값을 직접 입력
Key Value *	API 키의 실제 값입니다. [참고] 'Key Type’이 'Custom’일 경우 활성화
Description	API 키에 대한 설명입니다.

항목

설명

Key Name *

API 키의 이름입니다. 입력 조건은 다음과 같습니다.

고유한 값
영문자, 숫자, 특수문자(-, _, .)만 사용 가능

Key Type

API 키 값의 생성 방식입니다.

Auto Generate: 자동 생성
Custom: 사용자가 보유한 키 값을 직접 입력

Key Value *

API 키의 실제 값입니다.

[참고] 'Key Type’이 'Custom’일 경우 활성화

Description

API 키에 대한 설명입니다.

사용자 키 설정 항목

사용자 키의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
User Key Name	사용자 키의 이름입니다.
Description	사용자 키에 대한 설명입니다.
Role	사용자 키에 할당된 역할의 이름입니다.
Blacklist IP	해당 사용자 키를 포함한 요청 중에서 거부할 IP 주소입니다. 해당 항목에 설정된 IP 주소를 제외한 요청은 모두 허용됩니다. 수정 모드 상태에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 정보가 추가됩니다. 이후 정보를 수정할 경우 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다.
Blacklist Header/Body	해당 사용자 키를 포함한 요청 중에서 거부할 헤더 및 바디 정보입니다. 해당 항목에 설정된 헤더 및 바디를 제외한 요청은 모두 허용됩니다. 수정 모드 상태에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 정보가 추가됩니다. 이후 정보를 수정할 경우 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다.
Whitelist IP	해당 사용자 키를 포함한 요청 중에서 허용할 IP 주소입니다. 해당 항목에 설정된 IP 주소를 제외한 요청은 모두 거부됩니다. 수정 모드 상태에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 정보가 추가됩니다. 이후 정보를 수정할 경우 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다.
Whitelist Header/Body	해당 사용자 키를 포함한 요청 중에서 허용할 헤더 및 바디 정보입니다. 해당 항목에 설정된 헤더 및 바디를 제외한 요청은 모두 거부됩니다. 수정 모드 상태에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 정보가 추가됩니다. 이후 정보를 수정할 경우 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다.

항목

설명

User Key Name

사용자 키의 이름입니다.

Description

사용자 키에 대한 설명입니다.

Role

사용자 키에 할당된 역할의 이름입니다.

Blacklist IP

해당 사용자 키를 포함한 요청 중에서 거부할 IP 주소입니다. 해당 항목에 설정된 IP 주소를 제외한 요청은 모두 허용됩니다.

수정 모드 상태에서 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 정보가 추가됩니다. 이후 정보를 수정할 경우 figure response header edit icon 버튼을 클릭하고, 삭제할 경우 figure response header del icon 버튼을 클릭합니다.

Blacklist Header/Body

해당 사용자 키를 포함한 요청 중에서 거부할 헤더 및 바디 정보입니다. 해당 항목에 설정된 헤더 및 바디를 제외한 요청은 모두 허용됩니다.

Whitelist IP

해당 사용자 키를 포함한 요청 중에서 허용할 IP 주소입니다. 해당 항목에 설정된 IP 주소를 제외한 요청은 모두 거부됩니다.

Whitelist Header/Body

해당 사용자 키를 포함한 요청 중에서 허용할 헤더 및 바디 정보입니다. 해당 항목에 설정된 헤더 및 바디를 제외한 요청은 모두 거부됩니다.

인증 역할 설정 항목

인증 역할의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Role Name *	인증 역할의 이름입니다.
Description	인증 역할에 대한 설명입니다.
Policy List	인증 역할에 할당된 정책의 이름입니다.

항목

설명

Role Name *

인증 역할의 이름입니다.

Description

인증 역할에 대한 설명입니다.

Policy List

인증 역할에 할당된 정책의 이름입니다.

인증 정책 설정 항목

인증 정책의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Policy Name *	인증 정책의 이름입니다.
Description	인증 정책에 대한 설명입니다.

항목

설명

Policy Name *

인증 정책의 이름입니다.

Description

인증 정책에 대한 설명입니다.

HMAC 인증 공통 설정 항목

HMAC 인증의 공통 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Clock Skew	요청에 포함된 Date 값의 유효 시간입니다. (단위: ms) 설정한 시간을 초과한 요청은 인증에 실패합니다.
Enforce Headers	요청의 headers 필드에 반드시 포함되어야 하는 헤더 이름입니다. 수정 모드 상태에서 [+ Add Field] 버튼을 클릭하면 입력란이 추가되며, 추가한 필드를 삭제하려면 버튼을 클릭합니다.

항목

설명

Clock Skew

요청에 포함된 Date 값의 유효 시간입니다. (단위: ms)

설정한 시간을 초과한 요청은 인증에 실패합니다.

Enforce Headers

요청의 headers 필드에 반드시 포함되어야 하는 헤더 이름입니다.

수정 모드 상태에서 [+ Add Field] 버튼을 클릭하면 입력란이 추가되며, 추가한 필드를 삭제하려면 figure field del icon 버튼을 클릭합니다.

HMAC 키 설정 항목

HMAC 키 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
User ID *	HMAC 키에 할당할 사용자 ID입니다.
Key Type	비밀 키의 생성 방식입니다. Auto Generate: 시스템이 자동으로 비밀 키를 생성합니다. Custom: 사용자가 직접 비밀 키 값을 입력합니다. 선택 시 Secret Key 입력란이 활성화됩니다.
Description	HMAC 키에 대한 설명입니다.

항목

설명

User ID *

HMAC 키에 할당할 사용자 ID입니다.

Key Type

비밀 키의 생성 방식입니다.

Auto Generate: 시스템이 자동으로 비밀 키를 생성합니다.
Custom: 사용자가 직접 비밀 키 값을 입력합니다. 선택 시 Secret Key 입력란이 활성화됩니다.

Description

HMAC 키에 대한 설명입니다.

커스텀 인증 설정 항목

커스텀 인증 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Auth ID	커스텀 인증의 ID입니다. 자동으로 생성됩니다.
Issuer URL *	호출할 인증 서버의 URL을 지정합니다.
Token Settings > Token Key	토큰으로 사용할 헤더 키를 설정합니다.
Token Settings > Token TTL	성공한 토큰 캐시가 유지되는 시간을 설정합니다. 캐시의 키는 해당 값과 인증 서버의 주소의 조합을 사용합니다. (단위: ms)
Token Settings > Token Type	토큰의 타입을 설정합니다. 현재는 JWT만 지원합니다.
Endpoint Settings > Endpoint Type *	인증 서버로 사용할 엔드포인트의 타입입니다. IP Server Group ProObject K8s
Endpoint Settings > Scheme *	엔드포인트 서버의 프로토콜 타입입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Endpoint Settings > Host Address *	엔드포인트 서버의 IP 주소입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Endpoint Settings > Host Port *	엔드포인트 서버의 포트 번호입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Endpoint Settings > Method *	엔드포인트 서버의 메서드입니다. [참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화
Endpoint Settings > Endpoint Value *	엔드포인트 서버 그룹입니다. [참고] 'Endpoint Type’이 'Server Group' 또는 'ProObject’일 경우 활성화
Endpoint Settings > Header Parameter, Query Parameter	커스텀 인증 서버로 호출할 헤더나 쿼리를 설정합니다. 사용가능한 예약어 목록은 다음과 같습니다. $BASE64{값}: 값을 BASE64로 인코딩합니다. $UPPER{값}: 값을 대문자로 변환합니다. $LOWER{값}: 값을 소문자로 변환합니다. $TRIM{값}: 값의 앞뒤 공백을 제거합니다. ${token}: Token Settings에서 설정한 토큰 값을 입력합니다. ${request.header.<header_key>}: 요청 헤더를 입력합니다. ${request.query.<query_key>}: 요청 쿼리를 입력합니다. ${parameter.<parameter>}: 가변 경로 파라미터를 입력합니다. ${env.환경변수이름}: 환경 변수를 입력합니다. 수정 모드에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 파라미터가 추가됩니다. 파라미터를 수정할 경우 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다.

항목

설명

Auth ID

커스텀 인증의 ID입니다. 자동으로 생성됩니다.

Issuer URL *

호출할 인증 서버의 URL을 지정합니다.

Token Settings > Token Key

토큰으로 사용할 헤더 키를 설정합니다.

Token Settings > Token TTL

성공한 토큰 캐시가 유지되는 시간을 설정합니다. 캐시의 키는 해당 값과 인증 서버의 주소의 조합을 사용합니다. (단위: ms)

Token Settings > Token Type

토큰의 타입을 설정합니다. 현재는 JWT만 지원합니다.

Endpoint Settings > Endpoint Type *

인증 서버로 사용할 엔드포인트의 타입입니다.

IP
Server Group
ProObject
K8s

Endpoint Settings > Scheme *

엔드포인트 서버의 프로토콜 타입입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Endpoint Settings > Host Address *

엔드포인트 서버의 IP 주소입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Endpoint Settings > Host Port *

엔드포인트 서버의 포트 번호입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Endpoint Settings > Method *

엔드포인트 서버의 메서드입니다.

[참고] 'Endpoint Type’이 'IP' 또는 'K8s’일 경우 활성화

Endpoint Settings > Endpoint Value *

엔드포인트 서버 그룹입니다.

[참고] 'Endpoint Type’이 'Server Group' 또는 'ProObject’일 경우 활성화

Endpoint Settings > Header Parameter, Query Parameter

커스텀 인증 서버로 호출할 헤더나 쿼리를 설정합니다. 사용가능한 예약어 목록은 다음과 같습니다.

$BASE64{값}: 값을 BASE64로 인코딩합니다.
$UPPER{값}: 값을 대문자로 변환합니다.
$LOWER{값}: 값을 소문자로 변환합니다.
$TRIM{값}: 값의 앞뒤 공백을 제거합니다.
${token}: Token Settings에서 설정한 토큰 값을 입력합니다.
${request.header.<header_key>}: 요청 헤더를 입력합니다.
${request.query.<query_key>}: 요청 쿼리를 입력합니다.
${parameter.<parameter>}: 가변 경로 파라미터를 입력합니다.
${env.환경변수이름}: 환경 변수를 입력합니다.

수정 모드에서 figure response header create icon 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 figure response header save icon 버튼을 클릭하면 파라미터가 추가됩니다. 파라미터를 수정할 경우 figure response header edit icon 버튼을 클릭하고, 삭제할 경우 figure response header del icon 버튼을 클릭합니다.

에러 응답 매핑 설정 항목

에러 응답 매핑의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Error Mapping Id *	에러 응답 매핑의 ID입니다.
Description	에러 응답 매핑에 대한 설명입니다.
Error Mapping	에러 응답 매핑의 파라미터입니다. 수정 모드 상태에서 버튼을 클릭하면 각 항목의 입력란이 활성화되고, 값을 설정한 후 버튼을 클릭하면 파라미터가 추가됩니다. 이후 파라미터를 수정할 경우 버튼을 클릭하고, 삭제할 경우 버튼을 클릭합니다.

항목

설명

Error Mapping Id *

에러 응답 매핑의 ID입니다.

Description

에러 응답 매핑에 대한 설명입니다.

Error Mapping

에러 응답 매핑의 파라미터입니다.

QoS 설정 항목

QoS 정책의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
QoS Type *	QoS의 타입입니다. API Key User Key Stage Resource
Key Group *	QoS를 설정할 API 키가 속한 API 키 그룹의 ID입니다. [참고] 'QoS Type’이 'API Key’일 경우 활성화
Key *	API 키의 실제 값입니다. [참고] 'QoS Type’이 'API Key’일 경우 활성화
User Key *	QoS를 설정할 사용자 키의 ID입니다. [참고] 'QoS Type’이 'User Key’일 경우 활성화
API *	QoS를 설정할 스테이지가 속한 API의 ID입니다. [참고] 'QoS Type’이 'Stage’일 경우 활성화
Stage *	스테이지의 ID입니다. [참고] 'QoS Type’이 'Stage’일 경우 활성화
Resources *	QoS를 설정할 리소스입니다. [참고] 'QoS Type’이 'Resource’일 경우 활성화
Description	QoS 정책에 대한 설명입니다.
QoS Second *	1초 동안 요청 처리 건수입니다.
QoS Minute *	1분 동안 요청 처리 건수입니다.
QoS Hour *	1시간 동안 요청 처리 건수입니다.
QoS Day *	1일 동안 요청 처리 건수입니다.
QoS Month *	1달 동안 요청 처리 건수입니다.

항목

설명

QoS Type *

QoS의 타입입니다.

API Key
User Key
Stage
Resource

Key Group *

QoS를 설정할 API 키가 속한 API 키 그룹의 ID입니다.

[참고] 'QoS Type’이 'API Key’일 경우 활성화

Key *

API 키의 실제 값입니다.

[참고] 'QoS Type’이 'API Key’일 경우 활성화

User Key *

QoS를 설정할 사용자 키의 ID입니다.

[참고] 'QoS Type’이 'User Key’일 경우 활성화

API *

QoS를 설정할 스테이지가 속한 API의 ID입니다.

[참고] 'QoS Type’이 'Stage’일 경우 활성화

Stage *

스테이지의 ID입니다.

[참고] 'QoS Type’이 'Stage’일 경우 활성화

Resources *

QoS를 설정할 리소스입니다.

[참고] 'QoS Type’이 'Resource’일 경우 활성화

Description

QoS 정책에 대한 설명입니다.

QoS Second *

1초 동안 요청 처리 건수입니다.

QoS Minute *

1분 동안 요청 처리 건수입니다.

QoS Hour *

1시간 동안 요청 처리 건수입니다.

QoS Day *

1일 동안 요청 처리 건수입니다.

QoS Month *

1달 동안 요청 처리 건수입니다.

알람 규칙 설정 항목

알람 규칙의 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Single Rule Name *	알람 규칙의 이름입니다. 이름은 반드시 '_rule’로 끝나야 하며 다른 규칙과 중복될 수 없습니다. [참고] '_rule’은 직접 입력하지 않아도 알람 규칙 생성 시 자동으로 추가됩니다.
Resources *	모니터링할 리소스입니다.
Description	알람 규칙에 대한 설명입니다.
Type	알람 발생 조건의 유형을 지정합니다. Timeout: 'Connection Timeout' 또는 'Read Timeout' 발생 시 알람 Error Code: 에러 코드 발생 시 알람 Response Latency: 응답 지연 발생 시 알람
Threshold	알람 발생의 기준인 임계값입니다. 1 이상의 값을 입력해야 합니다.
Operation	알람을 발생하기 위해 임계값과 비교하는 데 사용할 비교 연산자입니다.
Detected Period(min)	알람 조건을 검사하는 주기입니다. (단위: 분)
Count	지정한 기간(Period)동안 임계값을 초과해야 하는 횟수입니다. 해당 값에 도달하면 알람이 발생합니다.
Alarm Message	알람이 발생할 때 보낼 메시지입니다.
Silence Period(min)	알람 발생 조건이 충족된 상태에서 알람을 발생시키지 않을 시간 간격입니다. (단위: 분)
Tags	알람 규칙에 추가되는 태그로 'key:value' 형식으로 설정합니다.

항목

설명

Single Rule Name *

알람 규칙의 이름입니다. 이름은 반드시 '_rule’로 끝나야 하며 다른 규칙과 중복될 수 없습니다.

[참고] '_rule’은 직접 입력하지 않아도 알람 규칙 생성 시 자동으로 추가됩니다.

Resources *

모니터링할 리소스입니다.

Description

알람 규칙에 대한 설명입니다.

Type

알람 발생 조건의 유형을 지정합니다.

Timeout: 'Connection Timeout' 또는 'Read Timeout' 발생 시 알람
Error Code: 에러 코드 발생 시 알람
Response Latency: 응답 지연 발생 시 알람

Threshold

알람 발생의 기준인 임계값입니다. 1 이상의 값을 입력해야 합니다.

Operation

알람을 발생하기 위해 임계값과 비교하는 데 사용할 비교 연산자입니다.

Detected Period(min)

알람 조건을 검사하는 주기입니다. (단위: 분)

Count

지정한 기간(Period)동안 임계값을 초과해야 하는 횟수입니다. 해당 값에 도달하면 알람이 발생합니다.

Alarm Message

알람이 발생할 때 보낼 메시지입니다.

Silence Period(min)

알람 발생 조건이 충족된 상태에서 알람을 발생시키지 않을 시간 간격입니다. (단위: 분)

배포 스케줄러 설정 항목

배포 스케줄러 설정 항목에 대한 설명은 다음과 같습니다. (*: 필수 설정 항목)

항목	설명
Gw Group ID *	배포할 게이트웨이 그룹 ID입니다. (기본값: apigw-group)
Deploy Type *	배포 타입이 스테이지 배포인지 리소스 배포인지 나타냅니다. (기본값: Stage)
API *	배포할 스테이지 상위의 API ID입니다.
Stage *	배포할 스테이지입니다.
Enable	해당 스케줄러의 활성화 여부입니다. (기본값: false)
Period Type *	설정한 기간 단위로 배포가 수행되는지, 설정한 시점에 배포가 수행되는지 나타냅니다. (기본값: week)
Active Week *	Period Type이 week인 경우 활성화되며, 배포를 진행할 요일을 나타냅니다.
Active Time *	Period Type이 week인 경우 활성화되며, 배포를 진행할 시간을 나타냅니다. [참고] Active Week에서 설정한 요일, Active Time에서 설정한 시간에 배포가 수행됩니다.
Repeat Minute *	Period Type이 'minute’인 경우 활성화되며, 배포를 진행할 주기를 나타냅니다. (단위: 분)
Description	해당 배포 스케줄러에 대한 설명을 나타냅니다.

항목

설명

Gw Group ID *

배포할 게이트웨이 그룹 ID입니다. (기본값: apigw-group)

Deploy Type *

배포 타입이 스테이지 배포인지 리소스 배포인지 나타냅니다. (기본값: Stage)

API *

배포할 스테이지 상위의 API ID입니다.

Stage *

배포할 스테이지입니다.

Enable

해당 스케줄러의 활성화 여부입니다. (기본값: false)

Period Type *

설정한 기간 단위로 배포가 수행되는지, 설정한 시점에 배포가 수행되는지 나타냅니다. (기본값: week)

Active Week *

Period Type이 week인 경우 활성화되며, 배포를 진행할 요일을 나타냅니다.

Active Time *

Period Type이 week인 경우 활성화되며, 배포를 진행할 시간을 나타냅니다.

[참고] Active Week에서 설정한 요일, Active Time에서 설정한 시간에 배포가 수행됩니다.

Repeat Minute *

Period Type이 'minute’인 경우 활성화되며, 배포를 진행할 주기를 나타냅니다. (단위: 분)

Description

해당 배포 스케줄러에 대한 설명을 나타냅니다.