Podręcznik weryfikacji interfejsu API REST NetWorker

Obejrzyj w serwisie YouTube

Rozpoczęcie pracy

Nawiązywanie połączenia z NetWorker:

• Content-Type: application/json
• Akceptuję: application/json
• Authorization: Podstawowy z nazwą użytkownika i hasłem zakodowanym w formacie Base 64

W środowiskach, w których istnieje wiele stref danych NetWorker uwierzytelnianych za pośrednictwem jednego serwera NetWorker AUTHC, wymagany jest dodatkowy nagłówek:

• X-NW-AUTHC-BASE-URL:AUTHC_HOSTNAME_OR_IP:AUTHC_PORT

Interfejs API REST NetWorker jest uwidoczniony w następującym podstawowym identyfikatorze URI:

https://[nw-server-hostname]:9090/nwrestapi/

https://[nw-server-hostname]:9090/nwrestapi/v1
https://[nw-server-hostname]:9090/nwrestapi/v2
https://[nw-server-hostname]:9090/nwrestapi/v3

Pełny schemat JSON jest dostępny pod adresem

https://[nw-server-hostname]:9090/nwrestapi/v3/schemas/swagger.json

Funkcje interfejsu API REST

Kilka przykładów:

GET

Wyświetl listę wszystkich klientów.                                            

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients

Tylko jeden klient, pokazujący tylko trzy pola (nazwa hosta, saveSets i protectionGroups)      

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?fl=hostname,saveSets,protectionGroups&q=hostname:nwserver121

Wyświetl listę grup ochrony, do których należy jeden klient.     

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?fl=protectionGroups&q=hostname:nwserver121

Pokaż bieżące alerty.                                     

https://[nw-server-hostname]:9090/nwrestapi/v3/global/alerts

Pokaż ostatnie zadania, które zakończyły się niepowodzeniem.                               

https://[nw-server-hostname]:9090/nwrestapi/v3/global/jobs?q=completionStatus:"Failed"&fl=clientHostname,startTime,name,message

Wyświetl listę przepływów pracy w jednej zasadzie (w tym przykładzie o nazwie WinFS ).                   

https://[nw-server-hostname]:9090/nwrestapi/v3/global/protectionpolicies/WinFS/workflows

Wyświetla listę właściwości tylko jednej instancji zestawu zapisu (zdefiniowanej przez nazwę hosta klienta i zestaw zapisu).      

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?q=hostname:vm-lego-231 and saveSets:"/etc"

POST:

Rozpocznij akcję przepływu pracy.                                 

https://[nw-server-hostname]:9090/nwrestapi/v3/global/protectionpolicies/Angela/workflows/WinFS/op/backup
                                                      JSON Body: 
                                                      {
                                                       }

Utwórz nową instancję klienta (z wartościami domyślnymi dla wszystkich właściwości z wyjątkiem czterech wymienionych).           

https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients  
                                                     JSON Body 
                                                     {    
            "hostname": "vm-lego-231",
            "backupType": "Filesystem",
            "saveSets": [ "/etc" ],
            "protectionGroups" : [ "LinuxFS" ]
                                                          

Informacje wymagane do uzyskania pomocy technicznej

Środowisko:

• Nazwa serwera NetWorker
• Wersja i numer kompilacji NetWorker
• Typ i wersja systemu operacyjnego hosta serwera NetWorker

Linux:

hostname
strings /usr/sbin/nsrd | grep -i "(#)"
cat /etc/*release
uname -a

Windows:

nsrwatch

• Wyjaśnij, która operacja interfejsu API REST jest wykonywana (GET, POST, PUT, DELETE), używany identyfikator URI, zawartość treści JSON (jeśli dotyczy). 
• Kod odpowiedzi interfejsu API REST i wszelkie wyświetlone komunikaty o błędach.
• Czy początkowe połączenie i autoryzacja między klientem interfejsu API REST a NetWorker zakończyły się pomyślnie?

• Wyrenderowany plik dziennika daemon.raw z serwera NetWorker:
  • Linux: /nsr/logs/daemon.raw
  • Windows: C:\Program Files\EMC NetWorker\nsr\logs\daemon.raw
  • NetWorker: korzystanie z nsr_render_log
• Dzienniki interfejsu API REST z serwera NetWorker:  /nsr/logs/restapi (Linux) lub EMC NetWorker\nsr\logs\restapi (Windows)
• W przypadku problemów z uwierzytelnianiem zapoznaj się ze standardowym logowaniem uwierzytelniania NetWorker w /nsr/authc/logs (linux) lub .. \EMC NetWorker\nsr\authc-server\tomcat\logs (Windows)

top -b | awk '/nsrtomc+/ {print strftime("%Y-%m-%d-%H:%M:%S", systime()), $0}'

To wyjście pokazuje standardowe górne wyjście, ale ze znacznikami czasu czytelnymi dla człowieka. Może to służyć do przeglądania użycia procesora CPU i pamięci przez proces oraz tego, jak długo pozostawał w określonym stanie, gdy wykonano wywołanie REST. Można to porównać z dziennikami restapi.log i AUTHC, aby zobaczyć, które wywołania zostały wykonane i jak często.
 

Windows: W przypadku serwerów z systemem Windows należy zainstalować coś w rodzaju "Monitor wydajności:

1. Otwórz Monitor wydajności jako administrator.
2. W lewym okienku rozwiń Narzędzia monitorowania i wybierz Monitor wydajności.
3. Kliknij prawym przyciskiem myszy w prawym okienku i wybierz polecenie Usuń wszystkie liczniki.
4. Kliknij prawym przyciskiem myszy w prawym okienku i wybierz polecenie Dodaj liczniki.
5. W obszarze Dostępne liczniki rozwiń pozycję Pamięć, wybierz wartość % zatwierdzonych bajtów i kliknij przycisk Dodaj.
6. W obszarze Pamięć  wybierz opcję Dostępne bajty i kliknij przycisk Dodaj.
7. W obszarze Dostępne liczniki rozwiń pozycję Proces i wybierz opcję % czasu procesora, a następnie w obszarze Wystąpienia wybranego obiektu wybierz pierwszy wpis Java kliknij przycisk Dodaj.
8. W obszarze Dostępne liczniki rozwiń Informacje o procesorze i wybierz opcję % Narzędzie procesora, kliknij przycisk Dodaj.
9. Dodano liczniki w prawym okienku powinny zawierać:

10. Kliknij przycisk OK. Kliknij prawym przyciskiem myszy pozycję Monitor wydajności, a następnie kliknij opcję Nowy zestaw modułów> zbierających dane.
11. Podaj nazwę, np.: RESTAPI_MON.
12. Na ekranie lokalizacji kliknij przycisk Dalej,chyba  że zdecydujesz się określić alternatywną lokalizację wyjściową.
13. Wybierz opcję Zapisz i zamknij , a następnie kliknij przycisk Zakończ.
14. W lewym okienku w obszarze Zestawy modułów> zbierających dane — zdefiniowane przez użytkownika otwórz właściwości RESTAPI_MON i wybierz opcję Rozdzielane przecinkami jako format dziennika, kliknij przycisk OK.

15. W lewym okienku w obszarze Zestawy> modułów zbierających dane — zdefiniowane przez użytkownika wybierz zestaw RESTAPI_MON zbierania danych i kliknij przycisk Start (przycisk Odtwórz).
16. Jeśli użyto domyślnej lokalizacji wyjściowej, plik .csv jest wyświetlany w folderze C:\PerfLogs\Admin\RESTAPI_MON.
17. Po zaobserwowaniu problemu i zarejestrowaniu go w pliku wyjściowym można zatrzymać monitorowanie, klikając opcję Zatrzymaj w obszarze Zestawy modułów zbierających dane — zdefiniowane przez użytkownika.

Dalsze zasoby

Wszystkie obsługiwane punkty końcowe interfejsu API REST i przykłady użycia są dostępne w: Podręcznik referencyjny interfejsu NetWorker REST API