설정 항목

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

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)	서버로부터 응답을 받는데 소요되는 시간입니다.
Thread Pool	리소스에 사용할 스레드 풀입니다.
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	인증 방식입니다.
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)

서버로부터 응답을 받는데 소요되는 시간입니다.

Thread Pool

리소스에 사용할 스레드 풀입니다.

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

인증 방식입니다.

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’일 경우 활성화

동적 라우팅 설정 항목

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

항목	설명
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’일 경우 활성화

항목

설명

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 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 *

프록시 서버의 경로입니다.

파라미터 설정 항목

요청 파라미터 설정 항목

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

헤더 파라미터

항목	설명
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: 헤더 제거

응답 헤더 설정 항목

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

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)

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)
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)

Connection Timeout *

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

Read Timeout *

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

Failover Timeout *

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

Failover Error Code *

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

System Log

항목	설명
Log Level *	저장할 시스템 로그 레벨입니다. 해당 로그 레벨 이상 등급의 로그를 시스템에 저장합니다.
System Rotate Type *	시스템 로그 파일의 로테이트 타입입니다. TIMEBASE: 설정한 시간 주기로 로테이트 SIZE: 설정한 파일 크기를 초과할 시 로테이트
System Rotate Parameter *	로테이트가 동작할 시간 주기 또는 파일 크기입니다.
Compress *	시스템 로그 데이터의 압축 여부입니다.
Log Time Zone *	시스템 로그에 표시될 시간 기준입니다.
Log Format *	시스템 로그의 포맷입니다.
Expiration Period *	시스템 로그의 만료 주기입니다.

항목

설명

Log Level *

저장할 시스템 로그 레벨입니다. 해당 로그 레벨 이상 등급의 로그를 시스템에 저장합니다.

System Rotate Type *

시스템 로그 파일의 로테이트 타입입니다.

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

System Rotate Parameter *

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

Compress *

시스템 로그 데이터의 압축 여부입니다.

Log Time Zone *

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

Log Format *

시스템 로그의 포맷입니다.

Expiration Period *

시스템 로그의 만료 주기입니다.

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

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

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

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

에러 응답 매핑 설정 항목

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

항목	설명
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)

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