--- title: "API Gateway 개요" slug: "ai-application-service-apigateway" tags: ["API Gateway", "overview"] updated: 2026-09-17T09:15:58Z published: 2026-09-17T09:15:58Z canonical: "api.ncloud-docs.com/ai-application-service-apigateway" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # API Gateway 개요

Classic/VPC 환경에서 이용 가능합니다.

API Gateway는 API 호출과 관련된 모든 작업을 편리하게 관리할 수 있는 네이버 클라우드 플랫폼의 서비스입니다. API Gateway 서비스에서는 API를 안정적으로 운영하기 위한 다양한 관리 기능과 사용 현황을 실시간으로 확인할 수 있는 대시보드 기능에 대한 API를 RESTful 형태로 제공합니다. ## API Gateway 공통 설정 API Gateway API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다. ### 요청 공통 요청 형식을 설명합니다. #### API URL 요청 API URL은 다음과 같습니다. ```HTTP https://apigateway.apigw.ntruss.com ``` #### 요청 헤더 요청 헤더에 대한 설명은 다음과 같습니다. | 필드 | 필수 여부 | 설명 | | --- | --- | --- | | `x-ncp-apigw-timestamp` | Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초) | | `x-ncp-iam-access-key` | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key | | `x-ncp-apigw-signature-v2` | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 매핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 | | `Content-Type` | Required | 요청 바디의 Content-Type을 `application/json`으로 지정 | ### 응답 공통 응답 형식을 설명합니다. #### 응답 바디 응답 바디에 대한 설명은 다음과 같습니다. **error** error는 API 호출 실패 정보를 정의합니다. error에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `errorCode` | String | Required | 오류 코드 | | `message` | String | Required | 오류 메시지 | | `details` | String | Optional | 오류 상세 정보 | #### 응답 상태 코드 응답 상태 코드에 대한 설명은 다음과 같습니다. | HTTP 상태 코드 | 코드 | 메시지 | 설명 | | --- | --- | --- | --- | | 200 | - | OK | 요청 성공 | | 201 | - | Created | 요청의 결과로 새로운 리소스가 생성됨 | | 202 | - | Accepted | 요청이 수락되었지만 아직 완료되지 않음 | | 204 | - | No Content | 요청은 성공했지만 응답 콘텐츠 없음 | | 400 | 100 | Bad Request Exception | HTTPS 프로토콜이나 UTF-8 인코딩으로 인한 요청 오류 | | 401 | 200 | Authentication Failed | 요청한 리소스를 사용하기 위한 인증 정보가 제공되지 않았거나 유효하지 않음 | | 401 | 210 | Permission Denied | 요청한 리소스에 대한 권한이 없음 | | 403 | 230 | Forbidden | 요청한 리소스에 대한 권한이 없음 | | 404 | 300 | Not Found Exception | 요청한 리소스를 찾을 수 없음 | | 429 | 400 | Quota Exceeded | API 사용 한도(Quota) 초과 | | 429 | 410 | Throttle Limited | API 요청 속도 초과 | | 429 | 420 | Rate Limited | API 요청 속도 초과 | | 413 | 430 | Request Entity Too Large | 요청 바디 크기가 서버가 처리할 수 있는 한계 초과 | | 415 | 440 | Unsupported Media Type | 지원되지 않는 미디어 유형 | | 503 | 500 | Endpoint Error | 엔드포인트 연결 에러 | | 504 | 510 | Endpoint Timeout | 엔드포인트 연결 시간 초과 | | 503 | 520 | Unknown Endpoint Domain | 엔드포인트가 인식되지 않거나 설정되지 않음 | | 503 | 530 | Connection Closed By Endpoint | 엔드포인트에서 연결 종료 | | 500 | 900 | Unexpected Error | 예기치 않은 상황으로 요청 처리 실패 | :::(Info) (참고) 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/common-ncpapi#3응답상태코드)를 참조해 주십시오. ::: #### 응답 예시 호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다. ```json { "error": { "errorCode": "200", "message": "Authentication Failed", "details": "Invalid authentication information." } } ``` ## API Gateway API API Gateway 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다. | 분류 | 설명 | | --- | --- | | API | API 생성, 조회, 수정, 삭제, 배포, 게시 및 Swagger 가져오기 | | API Key | API Key 생성, 조회, 수정, 삭제, 재생성 및 Product 구독 | | Authorizer | 인증 방식으로 사용할 Authorizer 생성, 조회, 수정, 삭제, 테스트 | | Canary Test | Canary 활성화, 비활성화, 수정, 승격 및 문서/SDK 내보내기 | | Dashboard API Key | API Key 기준 대시보드 데이터, API, Product 조회 및 엑셀 내보내기 | | Dashboard Event | API의 이벤트 이력 조회 | | Dashboard Product | Product 기준 대시보드 데이터, API, Product 조회 및 엑셀 내보내기 | | Document | Stage에 배포된 API 문서 조회 및 수정 | | Export | 배포된 API를 Swagger, OpenAPI, Java SDK 형식으로 내보내기 | | Gateway Response | 게이트웨이 응답 조회, 상태 코드 추가, 초기화 | | Gateway Response Header | 게이트웨이 응답에 사용자 정의 헤더 추가, 삭제 | | Gateway Response Template | 게이트웨이 응답 본문 매핑 템플릿 추가, 수정, 삭제 | | Method | Resource의 메서드 추가, 조회, 수정, 삭제 및 Consumer/Produce 설정 | | Method Request Body | 메서드 요청 바디 저장, 조회, 삭제 | | Method Request Parameter | 메서드 요청 파라미터(헤더, 쿼리 스트링) 추가, 조회, 삭제 | | Method Response | 메서드 응답 상태 코드 추가, 조회, 수정, 삭제 | | Method Response Body | 메서드 응답 바디 저장, 조회, 삭제 | | Method Response Header | 메서드 응답 헤더 추가, 조회, 삭제 | | Model | 요청/응답 바디 모델 추가, 조회, 수정, 삭제 및 미리보기 | | Product | Product 생성, 조회, 수정, 삭제 | | Published Product | 전체 계정에 게시된 Product 및 API 문서 조회 | | Resource | API의 리소스 생성, 조회, 수정, 삭제 및 Swagger 가져오기 | | Stage | Stage 생성, 조회, 수정, 삭제, 배포, Usage Plan 연결 및 캐시 초기화 | | Stage Deployment | Stage 배포 이력 및 게시된 문서 조회 | | Stage Resource | Stage의 메서드 설정 조회 및 덮어쓰기 | | Usage Plan | Usage Plan 생성, 조회, 수정, 삭제 및 연결된 Stage 조회 | ## API Gateway 연관 리소스 API Gateway API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다. * API Gateway API 사용 방법 * [서명(시그니처) 생성](/docs/common-ncpapi): 요청 헤더에 추가할 서명 생성 방법 * [Sub Account 사용 가이드](https://guide.ncloud-docs.com/docs/subaccount-overview){target="_blank"}: 요청 헤더에 추가할 Access Key 발급 방법 * [Ncloud 공통 응답 상태 코드](/docs/common-ncpapi#3응답상태코드): API Gateway 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보 * API Gateway 서비스 사용 방법 * [API Gateway 사용 가이드](https://guide.ncloud-docs.com/docs/apigw-apigw-1){target="_blank"}: 네이버 클라우드 플랫폼 콘솔에서 API Gateway 사용하는 방법 * [Ncloud 사용 환경 가이드](https://guide.ncloud-docs.com/docs/environment-environment-1-1){target="_blank"}: VPC, Classic 환경 및 지원 여부에 대한 가이드 * [요금 소개, 특징, 상세 기능](https://www.ncloud.com/product/applicationService/apiGateway){target="_blank"}: API Gateway의 요금 체계, 특징, 상세 기능 요약 * [서비스 최신 소식](https://www.ncloud.com/intro/news?categoryCode=APP&serviceCode=SV_0066){target="_blank"}: API Gateway 서비스 관련 최신 소식 * [자주 하는 질문](https://www.ncloud.com/support/faq/prod?categoryCode2=APP&categoryCode3=SV_0066){target="_blank"}: API Gateway 서비스 사용자들이 자주 하는 질문 * [문의하기](https://www.ncloud.com/support/question/general){target="_blank"}: API 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의