Wewnętrzny błąd portalu dla programistów

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

Krótki opis problemu

Podczas tworzenia żądania rzeczywistego żądania do interfejsu API przy użyciu SmartDokumentów w portalu dla programistów wystąpił błąd.

Komunikaty o błędach

Częstym błędem w portalu dla programistów jest „Wystąpił błąd wewnętrzny. Spróbuj jeszcze raz”.

Możliwe przyczyny

Ten błąd może wystąpić, gdy portal dla programistów nie otrzyma odpowiedzi z backendu (serwera proxy smartdocs lub samego punktu końcowego).

Diagnostyka

Włącz „Narzędzia dla deweloperów” w przeglądarce i sprawdź kartę sieci, aby zidentyfikować rzeczywisty błąd.

Typowe błędy i ich typowe przyczyny zostały wymienione w tej tabeli:

Błąd

Typowe przyczyny

ERR_NAME_NOT_RESOLVED

Błędnie skonfigurowany serwer proxy SmartDokumentacja lub ograniczenia zapory sieciowej

Treści mieszane

Portal skonfigurowany przez HTTP, a żądanie SmartDokumentacja przez HTTP

500 – wewnętrzny błąd serwera

Przyjrzyjmy się po kolei każdej z tych przyczyn i sprawdźmy, jak rozwiązać problem.

Błędnie skonfigurowany serwer proxy SmartDokumentacja lub ograniczenia zapory sieciowej

Komunikat „ERR_NAME_NOT_RESOLVED” oznacza, że URL serwera proxy smartdocs jest nieprawidłowo skonfigurowany lub sieć, z której uzyskuje się dostęp do portalu, nie może wywołać adresu URL serwera proxy smartdocs ze względu na ograniczenia zapory sieciowej. Serwer proxy smartdocs musi być dostępny w internecie lub w sieci wewnętrznej (w przypadku wewnętrznych interfejsów API).

Rozdzielczość

Aby zapewnić dostęp do serwera proxy smartdocs ze wszystkich wymaganych sieci, wdróż serwer proxy smartdocs na hoście wirtualnym w Edge z nazwą hosta dostępną z internetu.

Portal skonfigurowany przez HTTPS, żądania SmartDocuments przez HTTP

Błąd „Różne treści” oznacza, że serwer proxy smartdocs jest wywoływany przez HTTP ze strony wczytanej przez HTTPS.

Rozdzielczość

Aby rozwiązać ten problem, udostępnij serwer proxy smartdocs przez https. Możesz to zrobić, wdrażając serwer proxy smartdocs i dodając hosta wirtualnego skonfigurowanego do korzystania z TLS/SSL (zwykle jest to „bezpieczny” host wirtualny).

Serwer proxy inteligentnych Dokumentów zwraca wyjątek

Przyczyną wyświetlenia komunikatu 500 – wewnętrzny błąd serwera może być problem z serwerem proxy „smartdocs”. W tym przypadku zauważysz, że serwer proxy smartdocs zwraca ten błąd.

Diagnostyka

Użyj narzędzia do śledzenia, aby zdiagnozować błędy związane z serwerem proxy „smartdocs” w sposób opisany poniżej. Więcej informacji znajdziesz w artykule Korzystanie z narzędzia do śledzenia.

  1. Włącz śledzenie serwera proxy „smartdocs” w organizacji „VALIDATE”, aby znaleźć konkretną zasadę, która zwraca wewnętrzny błąd serwera 500.

  1. Wybierz konkretną zasadę w logu czasu, aby zidentyfikować przyczynę błędu.

Rozdzielczość

Napraw wykryty błąd. Jeśli potrzebujesz wsparcia, skontaktuj się z zespołem pomocy Apigee Edge.

Procesory wiadomości Edge nie mogą wywoływać opublikowanego punktu końcowego interfejsu API

500 – wewnętrzny błąd serwera może również wystąpić, gdy procesory wiadomości należące do organizacji hostującej serwer proxy Smartdocs nie mogą wywołać punktu końcowego API.

Diagnostyka

Użyj narzędzia do śledzenia, aby zdiagnozować błędy związane z serwerem proxy „smartdocs” w sposób opisany poniżej. Więcej informacji znajdziesz w artykule Korzystanie z narzędzia do śledzenia.

  1. Włącz trace dla serwera proxy „smartdocs” w organizacji „VALIDATE”, aby znaleźć konkretną zasadę, która zwraca wewnętrzny błąd serwera 500.

  1. W podanym wyżej przykładowym interfejsie użytkownika widać, że zasada JavaScript „BuildTargetAPIRequest” nie wykonuje docelowego adresu URL.
  1. Uzyskaj docelowy adres URL z zasady JavaScript „BuildTargetAPIRequest”.
  1. Wykonaj bezpośrednie wywołanie do adresu URL z węzłów procesora wiadomości powiązanych z organizacją „VALIDATE”, jak pokazano poniżej:
    curl -v <target URL>
    
  1. Wyeliminuj zaobserwowane błędy.

Rozdzielczość

  1. Sprawdź, czy interfejsy API opublikowane w portalu dla programistów można wywoływać z procesorów wiadomości powiązanych z organizacją „VALIDATE” i popraw wszelkie błędy.
  1. Jeśli możesz wykonać wywołanie interfejsu API bezpośrednio z procesora wiadomości, jest bardzo prawdopodobne, że będziesz w stanie uruchamiać ten interfejs API także za pomocą aplikacji SmartDokumentacja.
  1. Wykonaj wywołanie interfejsu API w SmartDokumentach i sprawdź, czy problem został rozwiązany.