일반적인 문제

API Gateway 서비스를 이용하면서 다음과 같은 문제를 겪을 수 있습니다. 문제별 원인과 해결 방법을 확인하고 적절하게 조치해 주십시오.

API 호출 오류

IAM 인증을 사용하여 API 호출 시 정상적으로 호출되지 않습니다.

원인

사용자의 작업 환경에 따라 다양한 원인이 있을 수 있습니다.

• 시그니처 값 생성 시 잘못된 URL을 사용했습니다.
• 호출하는 API와 Signature key 생성 시 사용되는 메서드가 다릅니다.
• 시그니처 값 생성 시 잘못된 timestamp를 사용했습니다.
• 클라이언트의 서버 시간이 맞지 않습니다.
• accessKey 값이 유효하지 않습니다.

해결 방법

시그니처 생성 시 잘못된 URL 사용
시그니처 생성 시 도메인을 제외한 path와 모든 쿼리 스트링을 사용해 주십시오. 호출하려는 API가 https://uh7m0wgsis.apigw.ntruss.com/photos/puppy.jpg?query1=&query2인 경우, 시그니처 생성에 사용되는 URL은 /photos/puppy.jpg?query1=&query2 입니다.

호출하는 API와 시그니처 생성 시 사용되는 메서드가 상이함
호출하는 API와 시그니처 생성 시 사용되는 메서드가 동일해야 정상적으로 호출할 수 있습니다. 호출하는 API와 시그니처 생성 시 사용되는 메서드가 동일한지 확인해 주십시오.

시그니처 생성 시 잘못된 timestamp 사용

• header(x-ncp-apigw-timestamp)와 시그니처 생성 시 동일한 timestamp 값을 사용해야 합니다. 호출에 실패할 경우, header와 시그니처의 timestamp 값을 별도로 획득하지 않았는지 확인해 주십시오.
• timestamp 값 획득 후 갱신 없이 사용하고 있는 것은 아닌지 확인해 주십시오.
• API Gateway 서버와의 시간 차가 5분 이상인 경우, 유효하지 않은 timestamp 값으로 판단합니다. timestamp 값을 획득한 후 갱신 없이 사용하는 경우, 최초 몇 번 호출 후 오류가 발생하기 때문에 간헐적으로 발생하는 문제인 것처럼 보일 수 있습니다. API 호출 시 timestamp 값을 새로 생성해 주십시오.

클라이언트의 서버 시간이 맞지 않는 경우
클라이언트의 서버 시간이 맞지 않는 경우, API Gateway에서 유효하지 않은 timestamp 값으로 판단하여 정상 호출이 불가할 수 있습니다. 클라이언트 서버 시간이 정확한지 확인해 주십시오.

accessKey 값이 유효하지 않은 경우
accessKey 값이 유효하지 않은 경우, IAM 인증 오류가 발생할 수 있습니다. API 호출 시 유효한 accessKey를 사용해 주십시오.

API Key 복구

삭제된 API Key를 복구할 수 없습니다.

원인

삭제된 API Key는 복구할 수 없습니다.

해결 방법

삭제된 API Key는 복구할 수 없으므로, 사용 중인 API Key를 삭제하지 않도록 주의해 주십시오.

CORS 오류

CORS 오류가 발생합니다.

원인

CORS 설정이 완료되지 않을 경우, 오류가 발생할 수 있습니다.

해결 방법

API Gateway 리소스의 CORS 설정을 완료해 주십시오. 자세한 내용은 리소스의 CORS 설정을 참조해 주십시오.

Endpoint로 VPC 내 사설 IP 지정 불가

API Gateway에서 처리하는 Endpoint 중 HTTP(S)의 URL을 내부 VPC로 지정하려고 하는데 지정되지 않습니다.

원인

API Gateway의 Endpoint로 VPC 내 사설 IP를 지정할 수 없습니다.

해결 방법

• 공인 IP 또는 외부에서 접근 가능한 도메인으로 지정해 주십시오.
• Public Load Balancer 등을 사용하여 외부에서 접근 가능하도록 설정한 후, 해당 Endpoint를 연동해 주십시오.

Cloud Function 연동 후 호출 시 오류 발생

리소스 Endpoint를 Cloud Function으로 지정하고 API 호출 시 오류가 반환됩니다.

원인

웹 액션 연동 시, 리소스 경로 설정이 잘못되었습니다.

해결 방법

웹 액션 연동 시 리소스 경로 {type+}를 설정하고, API 호출 시 콘텐츠 유형(예: http, json 등)을 지정하여 호출해 주십시오.
자세한 내용은 Cloud Functions의 웹 액션 또는 Cloud Functions 액션 호출 시 쿼리 파라미터 입력이 가능한가요?를 참조해 주십시오.