NetWorker REST API Triage-vejledning

Summary: Denne KB indeholder en oversigt over grundlæggende fejlfinding af RESTAPI-relaterede problemer.

This article applies to This article does not apply to This article is not tied to any specific product. Not all product versions are identified in this article.

Instructions

NetWorker REST API Triage-vejledning

Se på YouTube

Additional Information

Kom godt i gang


REST (Representational State Transfer) Application Programming Interface (API) giver programmeringsmæssig adgang til NetWorker-databeskyttelsestjenesten. Ved hjælp af REST API kan NetWorker-brugere bygge klientprogrammer for at automatisere NetWorker-handlinger. NetWorker REST API installeres som en del af NetWorker-serverinstallationen i den samme Apache tomcat-beholder som NetWorker-godkendelsestjenesterne. Godkendelse udføres ved hjælp af de samme legitimationsoplysninger, som bruges til NetWorker Management Console.  

REST API muliggør interaktion med ressourcer, der er identificeret ved URI-adresser (Uniform Resource Identifier). Den bruger HTTP-verber (HEAD, GET, PUT, POST, DELETE) til at interagere med URI'en (Uniform Resource Identifier) på en tilstandsløs måde (serveren indeholder ingen klienttilstand, hvor hver meddelelse er selvbeskrivende).

Dette dokument omhandler interaktionen med NetWorker-ressourcer ved hjælp af brugerskrevne REST API-kald. Ikke at forveksle med REST API-kald, der bruges af back-end NetWorker-handlinger.
 

Opretter forbindelse til NetWorker:

Der er flere forskellige REST API-klientteknologier, som kan bruges til at køre kommandoerne for at oprette forbindelse til NetWorker; herunder curl-kommandoer (Linux), PowerShell Invoke-WebRequest (Windows) og browserudvidelser til REST API-klienter. 

Der kræves tre overskrifter til tilslutning:   
  • Indholdstype: applikation/json
  • Accepter: ansøgning/json
  • Godkendelse: Basic med Base 64-kodet brugernavn og adgangskode

I miljøer, hvor der er flere NetWorker-datazoner, der godkendes via en enkelt NetWorker AUTHC-server, kræves der en ekstra header:

  • X-NW-AUTHC-BASE-URL:AUTHC_HOSTNAME_OR_IP:AUTHC_PORT
AUTHC-standardporten er port 9090. Brugen af denne overskrift er beskrevet i: RESTAPI: Hvordan bruges en ekstern AUTHC-server, når du behandler RESTAPI-anmodninger?

NetWorker REST API vises i følgende basis-URI:

https://[nw-server-hostname]:9090/nwrestapi/
Der findes forskellige versioner af API'er. Forbedringer er blevet udrullet, siden REST API oprindeligt blev implementeret. F.eks.:
https://[nw-server-hostname]:9090/nwrestapi/v1
https://[nw-server-hostname]:9090/nwrestapi/v2
https://[nw-server-hostname]:9090/nwrestapi/v3
Ændringer af disse slutpunkter er beskrevet i: https://developer.dell.com/apis/2378/versions/v3/docs/GettingStarted.md

Det fulde json-skema er tilgængeligt på

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

REST API-svarkoder:
 
Koder for succesrespons
Succeskode Gælder for HTTP-metode Respons kropsindhold Beskrivelse
200 Ressourcerepræsentation. OK. De handlinger, der resulterer i denne HTTP-tilstand, har ressourcerepræsentationen i nyttelasten.
201 INDLÆG Tomt svar. Lavet. Denne status angiver, at der er oprettet en ny ressource eller et tilsigtet job, og at den tilknyttede URL-adresse er tilgængelig fra placeringsoverskriften i svaret.
202 INDLÆG Detaljer som svar. Accepteret. Dette angiver, at API-anmodningen er blevet accepteret. Nyttedataene angiver, at URL-adressen til sporingsressourceforekomsten er tilgængelig fra placeringsoverskriften i svaret.
204 INDSÆT/SLET Tomt svar. Intet indhold. Staten angiver, at den udførte operation var vellykket. Der er dog ingen yderligere detaljer, der skal gives.
 
Fejlsvarkoder
Fejlkode Beskrivelse
400 Dårlig anmodning.
401 Ugyldige loginoplysninger.
403 Utilstrækkelige privilegier.
404 Ressourcen blev ikke fundet.
405 Metode ikke tilladt.
406 Ugyldig landestandard er angivet.
500 Intern serverfejl.


REST API-funktioner

Understøttede HTTP-metoder
HTTP-metode Handling Beskrivelse
Læse Får ressourcerepræsentationen.
INDLÆG Opret Opretter en ny ressource.
SÆTTE Opdater Opdaterer en eksisterende ressource.
SLETTE Fjern Sletter en eksisterende ressource.


Nogle eksempler:

GET

 

Angiv alle klienter.                                            

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

Kun én klient, der kun viser tre felter (værtsnavn, saveSets og protectionGroups)      

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

Angiv de beskyttelsesgrupper, som en klient er i.     

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

Vis aktuelle advarsler.                                     

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

Vis de seneste mislykkede job.                               

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

Angiv arbejdsprocesserne i én politik (kaldet WinFS i dette eksempel).                   

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

Angiv kun egenskaberne for én saveset-forekomst (som defineret af klientens værtsnavn og saveset).      

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

INDLÆG:

Start en arbejdsgangshandling.                                 

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

Opret en ny klientforekomst (med standardværdier for alle ejendomme undtagen de fire, der er angivet).           

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


Påkrævede oplysninger til support


Miljø:

  • NetWorker-servernavn
  • NetWorker-version og buildnummer
  • NetWorker-serverværtens operativsystemtype og -version
Linux:
hostname
strings /usr/sbin/nsrd | grep -i "(#)"
cat /etc/*release
uname -a

Windows:

nsrwatch
Problemoplysninger:
  • Forklar, hvilken REST API-handling der udføres (GET, POST, PUT, DELETE), den anvendte URI, eventuelt JSON-brødtekstindhold (hvis relevant). 
  • REST API-svarkode og eventuelle fejlmeddelelser.
  • Er den indledende forbindelse og godkendelse lykkedes mellem REST API-klienten og NetWorker?
Logindsamling:
  • Gengivet daemon.raw logfil fra NetWorker-serveren:
  • REST API-logfiler fra NetWorker-serveren:  /nsr/logs/restapi (linux) eller EMC NetWorker\nsr\logs\restapi (Windows)
  • For godkendelsesproblemer henvises til standard NetWorker-godkendelse, når du logger på /nsr/authc/logs (linux) eller .. \EMC NetWorker\nsr\authc-server\tomcat\logs (Windows)
Debug:
I mere komplekse problemer kan REST API-fejlfinding være påkrævet. Fejlfinding kan aktiveres i henhold til: NetWorker: Sådan aktiveres REST API-fejlfinding

Ydeevne
Hvis problemet er relateret til RESTAPI-ydeevne, kan du bruge følgende indstillinger til at spore ressourceforbruget for den nsrtomc+-proces, der bruges af API-kald.

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

Dette output viser standard topoutput, men med tidsstempler, der kan læses af mennesker. Dette kan bruges til at gennemgå CPU- og hukommelsesforbruget efter processen, og hvor længe den forblev i en bestemt tilstand, da der blev foretaget et REST-opkald. Dette kan sammenlignes med restapi.log- og AUTHC-logfilerne for at se, hvilke opkald der blev foretaget og hvor ofte.
 

Windows: For Windows-servere skal du installere noget som "Performance Monitor:

1. Åbn Ydelsesmåler som administrator.
2. Udvid Overvågningsværktøjer i venstre rude, og vælg Performance Monitor.
3. Højreklik inde i højre rude, og vælg Fjern alle tællere.
4. Højreklik inde i højre rude, og vælg Tilføj tællere.
5. Udvid Hukommelse under Tilgængelige tællere, vælg % Commit Bytes, og klik på Tilføj.6
. Vælg Tilgængelige bytes under Hukommelse,  og klik på Tilføj.
7. Udvid Proces under Tilgængelige tællere, og vælg % processortid, og vælg den første Java-post under Forekomster af markeret objekt, og klik på Tilføj.
8. Udvid Processoroplysninger under Tilgængelige tællere, og vælg % processorværktøj, og klik på Tilføj.
9. De tilføjede tællere i højre rude skal vise:

image.png

10. Klik på OK. Højreklik på Ydelsesmåler, og klik på >Nyt dataindsamlersæt.
11. Angiv et navn, f.eks.: RESTAPI_MON.
12. Klik på Næste på placeringsskærmen,  medmindre du vælger at angive en alternativ outputplacering.
13. Vælg Gem og luk , og klik på Udfør.
14. I venstre rude under Data Collector Sets –> User Defined skal du åbne de RESTAPI_MON egenskaber og vælge Kommasepareret som logformat, klikke på OK.

image.png

15. Vælg det RESTAPI_MON dataindsamlersæt under Data Collector Sets -> User Defined - i venstre rude, og klik på Start (knappen Afspil).
16. Hvis standardoutputplaceringen blev brugt, vises .csv filen under C:\PerfLogs\Admin\RESTAPI_MON.
17. Når problemet er observeret og registreret i outputfilen, kan du stoppe overvågningsklik ved at klikke på Stop under Data Collector Sets-User Defined.


Yderligere ressourcer

Alle understøttede REST API-slutpunkter og brugseksempler findes i: NetWorker REST API-referencevejledning

Affected Products

NetWorker Series

Products

NetWorker Series
Article Properties
Article Number: 000014298
Article Type: How To
Last Modified: 07 Feb 2024
Version:  6
Find answers to your questions from other Dell users
Support Services
Check if your device is covered by Support Services.