사용자는 Samsung Cloud Platform Console을 통해 API Gateway 서비스의 필수 정보를 입력하고, 상세 옵션을 선택하여 해당 서비스를 생성할 수 있습니다.
API 생성하기
API는 백엔드 HTTP 엔드포인트, Cloud Functions, 또는 기타 SCP 서비스와 통합된 리소스와 메서드의 집합입니다. API는 실제 서비스의 논리적 인터페이스를 제공하며, 여러 스테이지에 배포되어 다양한 환경(개발, 운영 등)에서 사용할 수 있습니다.
Samsung Cloud Platform Console에서 API를 생성하여 사용할 수 있습니다.
API를 생성하려면 다음 절차를 따르세요.
- 모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
- Service Home 페이지에서 API 생성 버튼을 클릭하세요. API 생성 페이지로 이동합니다.
- API 생성 페이지에서 서비스 생성에 필요한 정보들을 입력하고, 상세 옵션을 선택하세요.
- 서비스 정보 입력 영역에서 필요한 정보를 선택하세요.
구분 필수 여부상세 설명 API명 필수 API 이름 입력 - 영문 소문자로 시작하며 특수문자(
-)로 끝나지 않도록, 소문자, 숫자와 특수문자(-)를 사용하여 3 ~ 50자로 입력
API 생성 방법 필수 API 생성 방법 선택 - 새로 생성, 기존 API 복제 중에서 선택
복제할 API 필수 API 생성 방법을 기존 API 복제로 선택할 경우, 이미 생성되어 있는 API 중에서 선택 설명 선택 API에 대한 추가 정보나 설명을 50자 이내로 입력 API 엔드포인트 유형 필수 API에 접근할 수 있는 경로 - Region: API가 배포된 리전 내에서 요청 처리
- Private: 다른 VPC에서 프라이빗하게만 API를 요청받을 수 있도록 노출
- Private을 선택하면 JWT 활성화 적용
표. API 서비스 정보 입력 항목 - 영문 소문자로 시작하며 특수문자(
- 서비스 정보 입력 영역에서 필요한 정보를 선택하세요.
- 추가 정보 입력 영역에서 필요한 정보를 입력 또는 선택하세요.
구분 필수 여부상세 설명 태그 선택 태그 추가 - 태그 추가 버튼을 클릭하여 태그를 생성하여 추가하거나 기존 태그 추가 가능
- 최대 50개까지 태그 추가 가능
- 추가된 신규 태그는 서비스 생성 완료 후 적용
표. API 추가 정보 입력 항목
- 요약 패널에서 생성한 상세 정보와 예상 청구 금액을 확인하고, 완료 버튼을 클릭하세요.
- 생성이 완료되면, API 목록 페이지에서 생성한 자원을 확인하세요.
API 상세 정보 확인하기
API 서비스의 전체 자원 목록과 상세 정보를 확인하고 수정할 수 있습니다. API 상세 페이지는 상세 정보, 태그, 작업 이력 탭으로 구성되어 있습니다.
API 서비스의 상세 정보를 확인하려면 다음 절차를 따르세요.
- 모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
- Service Home 페이지에서 API 메뉴를 클릭하세요. API 목록 페이지로 이동합니다.
- API 목록 페이지에서 상세 정보를 확인할 자원을 클릭하세요. API 상세 페이지로 이동합니다.
- API 상세 페이지에는 상태 정보 및 부가 기능에 대한 정보가 표시되며, 상세 정보, 태그, 작업 이력 탭으로 구성됩니다.
구분 상세 설명 상태 표시 사용자가 생성한 API의 상태 - Creating: API 생성 중
- Active: API 정상 동작
- Deleting: API 삭제 중
- Error: API 내부 에러 발생으로 작업 불가능 상태
서비스 해지 서비스를 해지하는 버튼 표. API 상태 정보 및 부가 기능
- API 상세 페이지에는 상태 정보 및 부가 기능에 대한 정보가 표시되며, 상세 정보, 태그, 작업 이력 탭으로 구성됩니다.
상세 정보
API 상세 페이지에서 선택한 자원의 상세 정보를 확인하고, 필요한 경우 정보를 수정할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 서비스 | 서비스 이름 |
| 자원 유형 | 자원 유형 |
| SRN | Samsung Cloud Platform에서의 고유 자원 ID |
| 자원명 | 자원 이름 |
| 자원 ID | 서비스에서의 고유 자원 ID |
| 생성자 | 서비스를 생성한 사용자 |
| 생성 일시 | 서비스를 생성한 일시 |
| 수정자 | 서비스 정보를 수정한 사용자 |
| 수정 일시 | 서비스 정보를 수정한 일시 |
| API명 | API 이름 |
| API 엔드포인트 유형 | API 엔드포인트 유형 |
| DNS 상태 | DNS 상태
|
| 설명 | API에 대한 추가 정보나 설명 |
연결 관리
연결 관리 페이지에서 API Gateway용 PrivateLink Service에 대한 연결 요청을 관리할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 요청 Endpoint ID | 요청된 엔드포인트 ID |
| 생성 일시 | 서비스를 생성한 일시 |
| 상태 | 자원의 상태 값 |
| 거부 | PrivateLink Service 연결 요청 거부 |
| 승인 | PrivateLink Service 연결 요청 승인 |
| 차단 | 연결된 PrivateLink Endpoint 차단 |
| 재연결 | 차단된 PrivateLink Endpoint 다시 연결 |
- 연결 상태가 Rejected, Error인 경우에는 승인/거부 등 요청이 불가능합니다.
태그
API 상세 페이지에서 선택한 자원의 태그 정보를 확인하고, 추가하거나 변경 또는 삭제할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 태그 목록 | 태그 목록
|
작업 이력
API 상세 페이지에서 선택한 자원의 작업 이력을 확인할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 작업 이력 목록 | 자원 변경 이력
|
PrivateLink 서비스 연계하기
API Gateway 서비스와 PrivateLink 서비스를 연계하여 ‘API Gateway와 VPC’ 또는 ‘API Gateway와 다른 SCP 서비스’를 외부 인터넷 없이 연결할 수 있습니다. 데이터가 내부 네트워크만 이용하게되어 보안성이 높고, 퍼블릭 IP, NAT, VPN, 인터넷 게이트웨이 등이 필요하지 않습니다.
API Gateway서비스용 PrivateLink 서비스 생성하기
API 생성 시 엔드포인트 유형을 Private으로 선택하세요. API를 다른 VPC나 서비스에서 프라이빗하게 접근할 수 있도록 노출시킬 수 있습니다.
- Private Endpoint의 대상으로 지정하여 내부 네트워크를 이용할 수 있습니다. 사용자 VPC의 PrivateLink Endpoint 생성 방법은 PrivateLink Endpoint 생성하기를 참고하세요.
- API Gateway용 PrivateLink Service에 대한 연결 관리는 API 상세 정보 확인하기 > 연결 관리를 참고하세요.
PrivateLink Endpoint 생성하기
다른 PrivateLink에 접근하기 위한 Entry Point를 API Gateway 서비스에서 활용하기 위해 생성할 수 있습니다.
PrivateLink Endpoint를 생성하려면 다음 절차를 따르세요.
모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
Service Home 페이지에서 PrivateLink Endpoint 메뉴를 클릭하세요. PrivateLink Endpoint 목록 페이지로 이동합니다.
PrivateLink Endpoint 목록 페이지에서 PrivateLink Endpoint 생성 버튼을 클릭하세요. PrivateLink Endpoint 생성 페이지로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
구분 필수 여부상세 설명 PrivateLink Endpoint명 필수 PrivateLink Endpoint 이름 입력 - 영문과 숫자를 사용하여 3 ~ 20자로 입력
설명 선택 추가 정보나 설명을 50자 이내로 입력 PrivateLink Service ID 필수 연결할 PrivateLink Service의 ID 입력 - PrivateLink Service 제공자에게 사전에 Service ID를 확인하고, Endpoint 생성 이후에는 Endpoint ID를 제공자에게 전달
- 영문과 숫자를 사용하여 3 ~ 60자로 입력
표. PrivateLink Endpoint 생성 정보 입력 항목
- 필요한 정보를 입력 또는 선택하세요.
정보 입력 또는 선택이 완료되면 확인 버튼을 클릭하세요.
알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
- 생성이 완료되면, PrivateLink Endpoint 목록에서 생성한 자원을 확인하세요.
- PrivateLink Endpoint 목록을 삭제하려면, 목록에서 삭제할 자원을 선택한 후 삭제 버튼을 클릭하세요.
- PrivateLink를 통해 서비스 제공자에게 연결을 요청하려면, 승인 절차를 거쳐야 합니다.
- 서비스 연결을 신청할 때는 연결 대상인 PrivateLink Service ID를 사전에 확인해야 합니다.
- 서비스 신청 전에 서비스 제공자와의 사용 협의가 완료되어야 합니다.
- 사용자가 PrivateLink Endpoint를 생성한 후, 해당 Endpoint ID를 서비스 제공자에게 전달해야 합니다. 서비스 제공자는 사용자의 Endpoint ID를 확인하고 빠르게 사용 승인을 진행할 수 있습니다.
PrivateLink Endpoint 상세 정보 확인하기
PrivateLink Endpoint의 전체 자원 목록과 상세 정보를 확인하고 수정할 수 있습니다. PrivateLink Endpoint 상세 페이지는 상세 정보와 작업 이력 탭으로 구성되어 있습니다.
API 서비스의 상세 정보를 확인하려면 다음 절차를 따르세요.
- 모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
- Service Home 페이지에서 PrivateLink Endpoint 메뉴를 클릭하세요. PrivateLink Endpoint 목록 페이지로 이동합니다.
- PrivateLink Endpoint 목록 페이지에서 상세 정보를 확인할 자원을 클릭하세요. PrivateLink Endpoint 상세 페이지로 이동합니다.
- PrivateLink Endpoint 상세 페이지에는 상태 정보 및 부가 기능에 대한 정보가 표시되며, 상세 정보와 작업 이력 탭으로 구성됩니다.
구분 상세 설명 상태 표시 PrivateLink Endpoint의 상태 - Requesting: 연결 요청/승인 대기 중, 요청 취소 버튼 표시됨
- Active: 생성 완료, 작동 중
- Creating: 생성 중
- Deleting: 삭제 중
- Disconnected: 연결 차단
- Rejected: 연결 거부, 승인 재요청 버튼 표시됨
- Error: 오류 발생
- Canceled: 연결 요청이 취소됨, 승인 재요청 버튼 표시됨
요청 취소 연결 취소 요청 승인 재요청 연결 요청이 취소된 상태에서 연결 재요청 표. PrivateLink Endpoint 상태 정보 및 부가 기능
- PrivateLink Endpoint 상세 페이지에는 상태 정보 및 부가 기능에 대한 정보가 표시되며, 상세 정보와 작업 이력 탭으로 구성됩니다.
상세 정보
PrivateLink Endpoint 상세 페이지에서 선택한 자원의 상세 정보를 확인할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 서비스 | 서비스 이름 |
| 자원 유형 | 자원 유형 |
| SRN | Samsung Cloud Platform에서의 고유 자원 ID |
| 자원명 | 자원 이름 |
| 자원 ID | 서비스에서의 고유 자원 ID |
| 생성자 | 서비스를 생성한 사용자 |
| 생성 일시 | 서비스를 생성한 일시 |
| 수정자 | 서비스 정보를 수정한 사용자 |
| 수정 일시 | 서비스 정보를 수정한 일시 |
| PrivateLink Endpoint명 | PrivateLink Endpoint 이름 |
| PrivateLink Endpoint ID | PrivateLink Endpoint ID |
| PrivateLink Service ID | 연결된 PrivateLink Service ID |
| API 엔드포인트 유형 | API 엔드포인트 유형 |
| 설명 | PrivateLink Endpoint에 대한 추가 정보나 설명 |
작업 이력
PrivateLink Endpoint 상세 페이지에서 선택한 자원의 작업 이력을 확인할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 작업 이력 목록 | 자원 변경 이력
|
리소스 생성하기
리소스는 API 내에서 특정 엔드포인트(URI 경로)를 나타내는 논리적 단위입니다. 각 리소스는 트리 구조로 구성될 수 있으며, 여러 HTTP 메서드를 가질 수 있습니다.
리소스를 생성하려면 다음 절차를 따르세요.
모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
Service Home 페이지에서 API Gateway > 리소스 메뉴를 클릭하세요. 리소스 페이지로 이동합니다.
리소스 페이지에서 리소스 생성 버튼을 클릭하세요. 리소스 생성 팝업창으로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
구분 필수 여부상세 설명 리소스명 필수 리소스 이름 입력 - 영문 소문자로 시작하며 소문자, 숫자와 특수문자(
-{})를 사용하여 3 ~ 50자로 입력
- 중괄호를 사용하는 경우,
{문자}형식만 허용되며 비워둘 수 없음
리소스 경로 필수 리소스 메뉴트리에서 선택한 경로 선택 표. 리소스 생성 정보 입력 항목 - 영문 소문자로 시작하며 소문자, 숫자와 특수문자(
- 필요한 정보를 입력 또는 선택하세요.
정보 입력과 선택이 완료되면 확인 버튼을 클릭하세요.
알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
- 생성이 완료되면, 리소스 목록에서 생성한 자원을 확인하세요.
- 리소스를 삭제하려면, 목록에서 삭제할 자원을 선택한 후 삭제 버튼을 클릭하세요.
- 리소스는 최대 300개 생성 가능합니다.
- 리소스의 depth는 Root를 포함하여 30개까지입니다.
메서드 생성하기
메서드는 각 리소스에 대해 수행할 수 있는 HTTP 동작(예: GET, POST, PUT, DELETE 등)을 정의합니다. 각 메서드는 특정 백엔드와 통합되어 실제 데이터를 처리하거나 기능을 실행합니다.
메서드를 생성하려면 다음 절차를 따르세요.
모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
Service Home 페이지에서 API Gateway > 리소스 메뉴를 클릭하세요. 리소스 페이지로 이동합니다.
리소스 페이지에서 메서드 생성 버튼을 클릭하세요. 메서드 생성 팝업창으로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
구분 필수 여부상세 설명 메서드 유형 필수 메서드 유형 선택 - 기 생성된 값은 목록에 표시되지 않습니다.
- ANY를 선택하면 모든 유형의 메서드가 생성됨
통합 유형 필수 엔드포인트 유형 선택 - HTTP, Cloud Function, PrivateLink 중에서 선택
엔드포인트 URL 필수 HTTP 유형을 선택한 경우 엔드포인트 URL 입력 - 엔드포인트는 클라이언트가 API에 접근할 때 사용하는 고유 URL. 각 스테이지별로 별도의 엔드포인트 생성. Regional, Edge-Optimized, Private 등의 다양한 유형
- http:// 또는 https://로 시작하는 유효한 URL이어야 하며, 영문과 특수문자(
$-_.+!*’:(){}/)를 사용하여 500자 이내로 입력
엔드포인트 필수 Cloud Function 유형을 선택한 경우 엔드포인트 선택 - 리전은 현재의 리전으로 제공되며 변경 불가
URL 쿼리 문자열 파라미터 선택 사용에 체크한 후, 이름을 입력 - 영문, 숫자, 특수문자(
_)를 사용하여 입력
HTTP 요청 헤더 선택 사용에 체크한 후, 이름을 입력 - 영문, 숫자, 특수문자(
-)를 사용하여 입력
API Key 사용여부 선택 사용량 정책을 통해 사용량을 제한하려면 사용에 체크 표. 메서드 생성 정보 입력 항목
- 필요한 정보를 입력 또는 선택하세요.
정보 입력과 선택이 완료되면 저장 버튼을 클릭하세요.
알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
- 생성이 완료되면, 메서드 목록에서 생성한 자원을 확인하세요.
- 메서드를 삭제하려면, 목록에서 삭제할 자원을 선택한 후 삭제 버튼을 클릭하세요.
메서드는 종류별 각각 1개씩, 최대 7개까지 생성 가능합니다. Any로 생성시, 모든 종류의 메서드를 생성합니다.
| 구분 | 상세 설명 |
|---|---|
| 서비스 | 서비스명 |
| GET | 리소스 조회(읽기) |
| POST | 리소스 생성(등록) |
| PUT | 리소스 전체 수정(갱신) |
| PATCH | 리소스의 일부만 부분적으로 수정 |
| DELETE | 리소스 삭제 |
| OPTIONS | 해당 엔드포인트에서 지원하는 HTTP 메서드 목록 조회 |
| HEAD | 본문 없이 헤더만 조회(응답 바디 없이 메타데이터만 반환) |
API 배포하기
개발 중인 API를 실제 서비스 환경에 반영하려면 반드시 API 배포가 필요합니다.
생성된 API를 배포하려면 다음 절차를 따르세요.
모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
Service Home 페이지에서 API Gateway > 리소스 메뉴를 클릭하세요. 리소스 페이지로 이동합니다.
리소스 페이지에서 API 배포 버튼을 클릭하세요. API 배포 팝업창으로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
구분 필수 여부상세 설명 스테이지 필수 API를 배포할 스테이지 선택 - New Stage: 신규 스테이지를 생성하여 배포
- None Stage: 스테이지를 선택하지 않고 배포
스테이지명 필수 New Stage를 선택한 경우 신규 스테이지 이름 입력 - 영문 소문자로 시작하며 특수문자(
-)로 끝나지 않도록, 소문자, 숫자와 특수문자(-)를 사용하여 3 ~ 30자로 입력
배포 설명 선택 API 배포에 대한 추가 정보나 설명을 50자 이내로 입력 표. API 배포 정보 입력 항목
- 필요한 정보를 입력 또는 선택하세요.
정보 입력과 선택이 완료되면 배포 버튼을 클릭하세요.
알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
스테이지 생성하기
스테이지는 API 배포의 특정 시점(스냅샷)에 대한 명명된 참조로, 개발(dev), 테스트(test), 운영(prod) 등 API의 수명 주기별 환경을 구분합니다. 각 스테이지는 고유의 URL을 가지며, 캐싱, 로깅, 제한, 스테이지 변수 등 환경별로 별도의 설정이 가능합니다. 스테이지를 통해 Canary 릴리스, 환경별 설정, 트래픽 분리 등 다양한 운영 시나리오를 지원합니다.
API를 배포할 스테이지를 생성하려면 다음 절차를 따르세요.
모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
Service Home 페이지에서 API Gateway > 스테이지 메뉴를 클릭하세요. 스테이지 페이지로 이동합니다.
스테이지 페이지에서 스테이지 생성 버튼을 클릭하세요. 스테이지 생성 팝업창으로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
구분 필수 여부상세 설명 스테이지명 필수 New Stage를 선택한 경우 신규 스테이지 이름 입력 - 영문 소문자로 시작하며 특수문자(
-)로 끝나지 않도록, 소문자, 숫자와 특수문자(-)를 사용하여 3 ~ 50자로 입력
스테이지 설명 선택 스테이지에 대한 추가 정보나 설명을 100자 이내로 입력 API 배포 버전 필수 배포할 API 버전 선택 - 영문 소문자로 시작하며 특수문자(
-)로 끝나지 않도록, 소문자, 숫자와 특수문자(-)를 사용하여 3 ~ 50자로 입력
표. 스테이지 생성 정보 입력 항목 - 영문 소문자로 시작하며 특수문자(
- 필요한 정보를 입력 또는 선택하세요.
정보 입력과 선택이 완료되면 확인 버튼을 클릭하세요.
알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
- 생성이 완료되면, 스테이지 목록에서 생성한 자원을 확인하세요.
스테이지 상세 정보 확인하기
스테이지 목록과 상세 정보를 확인하고 수정할 수 있습니다. 상세 페이지는 스테이지 상세 정보와 API 배포 버전 관리, CORS, 사용량 정책 탭으로 구성되어 있습니다.
스테이지의 상세 정보를 확인하려면 다음 절차를 따르세요.
- 모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
- Service Home 페이지에서 API Gateway > 스테이지 메뉴를 클릭하세요. 스테이지 페이지로 이동합니다.
- 스테이지 목록에서 상세 정보를 확인할 자원을 클릭하세요.
- 스테이지 상세에는 상태 정보 및 부가 기능에 대한 정보가 표시되며, API 배포 버전 관리, CORS, 사용량 정책 탭으로 구성됩니다.
- 스테이지를 삭제하려면, 목록에서 삭제할 자원을 선택한 후 삭제 버튼을 클릭하세요.
- 스테이지를 수정하려면, 목록에서 수정할 자원을 선택한 후 수정 버튼을 클릭하세요.
스테이지 상세
스테이지 상세 페이지에서 선택한 자원의 상세 정보를 확인할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 스테이지명 | 스테이지 이름 |
| CORS | CORS 동작 상태 |
| 스테이지 설명 | 스테이지 정보 |
| JWT | JSON Web Token 사용 상태 |
| API Key | API Key 사용 여부 |
| Invoke URL | API 호출을 위한 URL |
| 활성화 일시 | 스테이지 활성화 일시 |
| 배포 ID | API 배포 ID |
API 배포 버전 관리
API 배포 버전 관리 탭에서 API 배포 이력을 확인할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| API 배포 버전 관리 목록 | API 배포 이력
|
| 배포 변경 | 목록에서 배포 변경할 자원을 선택한 후, 배포 변경 버튼을 클릭하세요. 알림 팝업창에서 확인 버튼을 클릭하면 활성화된 배포 ID가 즉시 업데이트됩니다. |
CORS (Cross-Origin Resource Sharing)
CORS 탭에서 CORS 목록을 확인할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 이름 | CORS 이름 |
| Mapping Value | CORS에 적용된 매핑값 |
사용량 정책
사용량 정책 탭에서 스테이지에 연결된 사용량 정책을 확인할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| 사용량 정책명 | 사용량 정책 이름 |
| 사용량 정책 ID | 사용량 정책 ID |
| 할당량 | 사용량 정책에 설정된 할당량 |
| 연결된 API Key명 | 사용량 정책에 연결된 API Key 이름 |
- API 호출시, ‘x-scp-apikey’ 헤더에 스테이지에 연결된 API Key의 Key값으로 호출해야 합니다.
- 사용량 정책은 스테이지 단위로 연결되지만, 할당량은 API Key 사용에 체크된 메서드별로 계산됩니다.
인증 생성하기
JWT(JSON Web Token)는 사용자 인증을 위해 사용되는 개방형 표준(RFC 7519)입니다. JWT는 JSON 형식을 이용하여 사용자에 대한 정보를 암호화된 토큰으로 저장하는 클레임 기반의 웹 토큰입니다.
JWT를 생성하려면 다음 절차를 따르세요.
모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
Service Home 페이지에서 API Gateway > 인증 메뉴를 클릭하세요. 인증 목록 페이지로 이동합니다.
인증 목록 페이지에서 JSON Web Token 생성 버튼을 클릭하세요. JSON Web Token 생성 팝업창으로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
구분 필수 여부상세 설명 JWT명 필수 토큰 이름 입력 - 영문 소문자로 시작하며 특수문자(
-)로 끝나지 않도록, 소문자, 숫자와 특수문자(-)를 사용하여 3 ~ 50자로 입력
연결할 스테이지 선택 사용에 체크한 후, 스테이지 선택 표. 인증 생성 정보 입력 항목 - 영문 소문자로 시작하며 특수문자(
- 필요한 정보를 입력 또는 선택하세요.
정보 입력과 선택이 완료되면 확인 버튼을 클릭하세요.
알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요. Access Token 알림 팝업창으로 이동합니다.
- 토큰은 Access Token 알림 팝업창에서만 확인할 수 있습니다. 필요한 경우, Access Token 파일을 다운로드하세요.
Access Token 알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
- 생성이 완료되면, 인증 목록에서 생성한 자원을 확인하세요.
- 토큰을 삭제하려면, 목록에서 삭제할 자원을 선택한 후 삭제 버튼을 클릭하세요.
- 토큰을 수정하려면, 수정하려는 자원의 컨텍스트 메뉴에서 수정을 선택하세요.
접근 제어 생성하기
API 호출 시 특정 IP에서만 호출되도록 접근 허용 IP를 추가할 수 있습니다.
- 스테이지는 하나의 접근 제어와 연결됩니다. 스테이지 최초 생성시 기본으로 Default 접근제어가 적용되어 모든 IP에 대한 접근을 차단합니다(All deny). 새로운 접근 제어를 생성하고, 스테이지에 연결하시면 특정 IP에서만 호출되도록 구성할 수 있습니다.
- 다음의 경우 접근 제어 생성을 할 수 없습니다.
- 사용 가능한 서비스 할당량 한도를 초과한 경우: Quota Service에서 현재 할당 값과 추가 가능한 값을 확인하세요.
- 사용 가능한 API가 없는 경우: API를 우선 생성하세요.
- API 엔드포인트 유형이 Private인 경우: 접근 제어가 지원되지 않지만, 해당 API의 스테이지에 JWT 활성이 필수로 적용됩니다.
접근 제어를 생성하려면 다음 절차를 따르세요.
모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
Service Home 페이지에서 API Gateway > 접근 제어 메뉴를 클릭하세요. 접근 제어 목록 페이지로 이동합니다.
접근 제어 목록 페이지에서 접근 제어 생성 버튼을 클릭하세요. 접근 제어 생성 팝업창으로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
구분 필수 여부상세 설명 접근 제어명 필수 접근 제어 이름 입력 - 영문 소문자로 시작하며 특수문자(
-)로 끝나지 않도록, 소문자, 숫자와 특수문자(-)를 사용하여 3 ~ 50자로 입력
Public 접근 허용 IP 필수 접근을 허용할 IP 입력 - ’,‘을 사용하여 최대 100개까지 입력 가능
연결할 스테이지 선택 사용에 체크한 후, 스테이지 선택 설명 선택 접근 제어에 대한 추가 정보나 설명을 50자 이내로 입력 표. 접근 제어 생성 정보 입력 항목 - 영문 소문자로 시작하며 특수문자(
- 필요한 정보를 입력 또는 선택하세요.
정보 입력과 선택이 완료되면 확인 버튼을 클릭하세요.
알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
- 생성이 완료되면, 접근 제어 목록에서 생성한 자원을 확인하세요.
- 접근 제어 목록을 삭제하려면, 목록에서 삭제할 자원을 선택한 후 삭제 버튼을 클릭하세요. Default 접근 제어는 삭제할 수 없습니다.
- 접근 제어를 수정하려면, 수정하려는 자원의 컨텍스트 메뉴에서 수정을 선택하세요.
API 해지하기
사용하지 않는 해당 서비스를 해지하여 운영 비용을 절감할 수 있습니다. 단, 서비스를 해지하면 운영 중인 서비스가 즉시 중단될 수 있으므로 서비스 중단 시 발생하는 영향을 충분히 고려한 후 해지 작업을 진행해야 합니다.
API를 해지하려면 다음 절차를 따르세요.
- 모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
- Service Home 페이지에서 API 메뉴를 클릭하세요. API 목록 페이지로 이동합니다.
- API 목록 페이지에서 해지할 자원을 선택하고, 서비스 해지 버튼을 클릭하세요.
- 해지가 완료되면, API 목록 페이지에서 자원이 해지되었는지 확인하세요.
Report 사용하기
API 트래픽, 성능, 오류 현황을 확인할 수 있습니다.
Report를 사용하려면 다음 절차를 따르세요.
- 모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
- Service Home 페이지에서 API Gateway > Report 메뉴를 클릭하세요. Report 페이지로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
| 구분 | 상세 설명 |
|---|---|
| 조회기간 | 조회할 날짜 선택 (현재 날짜로부터 기본 1주, 최대 한달 조회 가능) |
| 스테이지명 | API 하위의 스테이지 이름 |
- 정보 입력과 선택이 완료되면 Report 정보를 확인할 수 있습니다.
| 구분 | 상세 설명 |
|---|---|
| TOP 리소스 5 | 사용자가 호출한 리소스 중, API 상태코드가 2XX이며 가장 많이 호출한 상위 5개 (동일의 경우, 중복 순위로 나타내지 않음) |
| API 호출 횟수 | API 상태코드가 2XX인 호출 건수 |
| Latency | 사용자가 API Gateway에 요청을 보낸 시점부터 응답을 받을때까지 걸리는 시간 |
| Integration Latency | API Gateway가 백엔드 서버로 요청을 보낸 시점부터 백엔드에서 응답을 받을때까지 걸리는 시간 |
| 4XX Error | API 상태코드가 4XX인 호출 건수 |
| 5XX Error | API 상태코드가 5XX인 호출 건수 |
- 스테이지가 삭제되면 Report에서 조회할 수 없습니다.
- Report는 현재 시점으로부터 1시간 전 데이터가 조회됩니다.
사용량 정책 생성하기
사용량 정책은 서버 리소스의 효율적 분배, 서비스 안정성 확보, 불필요한 트래픽 방지 및 오용 방지를 위해 제정됩니다.
사용량 정책을 생성하려면 다음 절차를 따르세요.
- 모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
- Service Home 페이지에서 API Gateway > 사용량 정책 메뉴를 클릭하세요. 사용량 정책 페이지로 이동합니다.
- 사용량 정책 페이지에서 사용량 정책 생성 버튼을 클릭하세요. 사용량 정책 생성 페이지로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
| 구분 | 필수 여부 | 상세 설명 |
|---|---|---|
| 연결할 API명 | 필수 | 생성된 AIP 중에서 선택 |
| 사용량 정책명 | 필수 | 영문 소문자로 시작하며 특수문자(-)로 끝나지 않도록, 소문자, 숫자와 특수문자(-)를 사용하여 3 ~ 50자로 입력 |
| 할당량 | 필수 | 매월/매일/매시 기준 1 ~ 2,000,000,000 사이 입력 |
| 설명 | 선택 | 사용량 정책에 대한 설명을 50자 이내로 입력 |
- 정보 입력과 선택이 완료되면 완료 버튼을 클릭하세요.
- 알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
- 생성이 완료되면, 사용량 정책 목록에서 생성한 자원을 확인하세요.
API Key 생성하기
API Key는 어떤 사용자나 앱이 API를 호출하고 있는지 식별하는 데 사용됩니다. 사용량 정책에 의해 사용량을 제한하기 위해 주로 활용됩니다.
API Key를 생성하려면 다음 절차를 따르세요.
- 모든 서비스 > Application Service > API Gateway 메뉴를 클릭하세요. API Gateway의 Service Home 페이지로 이동합니다.
- Service Home 페이지에서 API Gateway > 사용량 정책 메뉴를 클릭하세요. 사용량 정책 페이지로 이동합니다.
- 목록에서 사용량 정책을 클릭하세요. 사용량 정책 상세 페이지로 이동합니다.
- 사용량 정책 상세 페이지에서 API Key 생성 버튼을 클릭하세요. API Key 추가 팝업창으로 이동합니다.
- 필요한 정보를 입력 또는 선택하세요.
| 구분 | 필수 여부 | 상세 설명 |
|---|---|---|
| API Key명 | 필수 | 영문 소문자로 시작하며 특수문자(-)로 끝나지 않도록, 소문자, 숫자와 특수문자(-)를 사용하여 3 ~ 50자로 입력 |
| 설명 | 선택 | API Key에에 대한 설명을 50자 이내로 입력 |
- 정보 입력과 선택이 완료되면 확인 버튼을 클릭하세요.
- 알림 팝업창에서 메시지를 확인한 후, 확인 버튼을 클릭하세요.
- 생성이 완료되면, 사용량 정책 상세 페이지에서 생성한 자원을 확인하세요.
- 사용량 정책은 10개, API Key는 5개 생성 가능합니다.
- 할당량은 API Key별로 계산됩니다.