개발자 포털 내부 오류

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

증상

개발자 포털에서 SmartDocs를 사용하여 라이브 API를 요청할 때 오류가 발생했습니다.

오류 메시지

개발자 포털에서 자주 발생하는 오류는 '내부 오류가 발생했습니다. 요청을 다시 시도하세요.'라는 오류 메시지가 표시됩니다.

가능한 원인

이 오류는 개발자 포털이 백엔드 (smartdocs 프록시 또는 실제 엔드포인트)의 응답을 받지 못할 때 발생할 수 있습니다.

진단

브라우저에서 '개발자 도구'를 사용 설정하고 네트워크 탭에서 실제 오류를 확인합니다.

일반적인 오류와 일반적인 원인은 다음 표에 나와 있습니다.

오류

일반적인 원인

ERR_NAME_NOT_RESOLVED

SmartDocs 프록시가 잘못 구성되었거나 네트워크 방화벽 제한

혼합 콘텐츠

HTTPS를 통해 구성된 포털, HTTP를 통해 SmartDocs 요청

500 - 내부 서버 오류

이러한 원인과 해결 방법을 하나씩 살펴보겠습니다.

SmartDocs 프록시가 잘못 구성되었거나 네트워크 방화벽 제한

'ERR_NAME_NOT_RESOLVED' 메시지는 Smartdocs 프록시 URL이 잘못 구성되었거나 포털에 액세스하는 네트워크에서 방화벽 제한으로 인해 Smartdocs 프록시 URL을 호출할 수 없음을 나타냅니다. 스마트 문서 프록시는 인터넷 또는 내부 네트워크 (내부 API의 경우)에서 액세스할 수 있어야 합니다.

해상도

인터넷에서 액세스할 수 있는 호스트 이름으로 Edge의 가상 호스트에 Smartdocs 프록시를 배포하여 모든 필수 네트워크에서 Smartdocs 프록시에 액세스할 수 있는지 확인합니다.

HTTPS를 통해 구성된 포털, HTTP를 통해 SmartDocs 요청

'혼합 콘텐츠' 오류는 Smartdocs 프록시가 HTTPS를 통해 로드된 페이지에서 HTTP를 통해 호출되고 있음을 나타냅니다.

해상도

문제를 해결하려면 https를 통해 Smartdocs 프록시를 노출하세요. 이렇게 하려면 Smartdocs 프록시를 배포하여 TLS/SSL을 사용하도록 구성된 가상 호스트(일반적으로 '보안' 가상 호스트)를 포함하세요.

예외를 반환하는 SmartDocs 프록시

500 - Internal Server Error 메시지는 'smartdocs' 프록시의 문제로 인해 발생할 수 있습니다. 이 경우 smartdocs 프록시가 이 오류를 반환합니다.

진단

아래에 설명된 대로 Trace 도구를 사용하여 'smartdocs' 프록시의 오류를 진단합니다. 자세한 내용은 추적 도구 사용을 참고하세요.

  1. 'VALIDATE' 조직에서 'smartdocs' 프록시에 대한 추적을 사용 설정하여 500 내부 서버 오류를 반환하는 특정 정책을 찾습니다.

  1. trace에서 특정 정책을 선택하여 오류의 원인을 파악하세요.

해상도

확인된 오류를 수정합니다. 도움이 필요한 경우 Apigee Edge 지원팀에 문의하세요.

에지 메시지 프로세서가 게시된 API 엔드포인트를 호출할 수 없음

500 - 내부 서버 오류는 Smartdocs 프록시를 호스팅하는 조직에 속한 메시지 프로세서가 API 엔드포인트를 호출할 수 없는 경우에도 발생할 수 있습니다.

진단

아래에 설명된 대로 Trace 도구를 사용하여 'smartdocs' 프록시의 오류를 진단합니다. 자세한 내용은 추적 도구 사용을 참고하세요.

  1. 'VALIDATE' 조직에서 'smartdocs' 프록시에 대한 trace를 사용 설정하여 500 내부 서버 오류를 반환하는 특정 정책을 찾습니다.

  1. 위에 표시된 샘플 UI 트레이스에서 자바스크립트 정책 'BuildTargetAPIRequest'가 타겟 URL을 실행하지 못하는 것을 볼 수 있습니다.
  1. 자바스크립트 정책 'BuildTargetAPIRequest'에서 대상 URL을 가져옵니다.
  1. 아래와 같이 'VALIDATE' 조직과 연결된 메시지 프로세서 노드에서 URL을 직접 호출합니다.
    curl -v <target URL>
    
  1. 관찰된 오류를 수정합니다.

해상도

  1. 개발자 포털에 게시된 API를 'VALIDATE' 조직과 연결된 메시지 프로세서에서 호출할 수 있는지 확인하고 발생한 오류를 수정합니다.
  1. 메시지 프로세서에서 직접 API 호출을 실행할 수 있는 경우 SmartDocs를 통해서도 API를 실행할 수 있어야 합니다.
  1. SmartDocs를 통해 API 호출을 실행하고 문제가 해결되었는지 확인합니다.