Sorteringsveiledning for NetWorker REST API

Summary: Denne kunnskapsartikkelen gir en oversikt over grunnleggende feilsøking for RESTAPI-relaterte 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

Sorteringsveiledning for NetWorker REST API

Se på YouTube

Additional Information

Startveiledning


REST (Representational State Transfer) API (Application Programming Interface) gir programmatisk tilgang til NetWorker-tjenesten for databeskyttelse. Ved hjelp av REST API kan NetWorker-brukere bygge klientprogrammer for å automatisere NetWorker-operasjoner. NetWorker REST API installeres som en del av NetWorker-serverinstallasjonen i samme Apache Tomcat-beholder som NetWorker-godkjenningstjenestene. Godkjenningen utføres med samme legitimasjon som brukes for NetWorker Management Console.  

REST API tillater samhandling med ressurser identifisert av URI-adresser (Uniform Resource Identifier). Den bruker HTTP-verb (HEAD, GET, PUT, POST, DELETE) for å samhandle med Uniform Resource Identifier (URI) på en tilstandsløs måte (serveren inneholder ingen klienttilstand, hver melding er selvbeskrivende).

Dette dokumentet omhandler samhandlingen med NetWorker-ressurser ved hjelp av brukerskrevne REST API-kall. Må ikke forveksles med REST API-kall som brukes av back-end NetWorker-operasjoner.
 

Koble til NetWorker:

Det finnes flere forskjellige REST API-klientteknologier som kan brukes til å kjøre kommandoene for å koble til NetWorker. inkludert curl-kommandoer (Linux), PowerShell Invoke-WebRequest (Windows) og nettleserutvidelser for REST API-klient. 

Det er tre overskrifter som trengs for tilkobling:   
  • Content-Type: application/json
  • Godta: søknad/json
  • Godkjenning: Grunnleggende med Base 64-kodet brukernavn og passord

I miljøer der det er flere NetWorker-datasoner som godkjennes via én enkelt NetWorker AUTC-server, kreves et ekstra hode:

  • X-NW-AUTHC-BASE-URL:AUTHC_HOSTNAME_OR_IP:AUTHC_PORT
Standard AUTHC-port er port 9090. Bruken av denne overskriften er detaljert i: RESTAPI: Hvordan bruker jeg en ekstern AUTC-server når du behandler RESTAPI-forespørsler?

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

https://[nw-server-hostname]:9090/nwrestapi/
Det finnes ulike versjoner av API-er. Forbedringer har blitt rullet ut siden REST API ble implementert. Eksempel:
https://[nw-server-hostname]:9090/nwrestapi/v1
https://[nw-server-hostname]:9090/nwrestapi/v2
https://[nw-server-hostname]:9090/nwrestapi/v3
Endringer i disse endepunktene er beskrevet i: https://developer.dell.com/apis/2378/versions/v3/docs/GettingStarted.md

Det fullstendige json-skjemaet er tilgjengelig på

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

REST API-svarkoder:
 
Koder for vellykket svar
Suksesskode Gjelder HTTP-metode Innhold i responskroppen Beskrivelse
200 Representasjon av ressurser. OK. Operasjonene som resulterer i denne HTTP-tilstanden, har ressursrepresentasjonen i nyttelasten.
201 INNLEGG Tom respons. Opprettet. Denne statusen angir at en ny ressurs eller en tiltenkt jobb er opprettet, og at den tilknyttede URL-adressen er tilgjengelig fra plasseringshodet i svaret.
202 INNLEGG Detaljer som svar. Akseptert. Dette indikerer at API-forespørselen er godtatt. Nyttelasten angir at URL-adressen til sporingsressursforekomsten er tilgjengelig fra lokasjonshodet i svaret.
204 PUT/SLETT Tom respons. Ikke noe innhold. Tilstanden indikerer at den utførte operasjonen var vellykket. Det er imidlertid ingen ytterligere detaljer som skal gis.
 
Svarkoder for feil
Feilkode Beskrivelse
400 Dårlig forespørsel.
401 Ugyldig legitimasjon.
403 Ikke tilstrekkelige rettigheter.
404 Finner ikke ressursen.
405 Metode ikke tillatt.
406 Ugyldig nasjonal innstilling er angitt.
500 Intern serverfeil.


REST API-funksjoner

HTTP-metoder som støttes
HTTP-metode Handling Beskrivelse
Lese Henter ressursrepresentasjonen.
INNLEGG Opprett Oppretter en ny ressurs.
SETTE Oppdater Oppdaterer en eksisterende ressurs.
SLETT Fjern Sletter en eksisterende ressurs.


Noen eksempler:

GET

 

Liste over alle klienter.                                            

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

Bare én klient, som bare viser tre felt (vertsnavn, saveSets og protectionGroups)      

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

Oppgi beskyttelsesgruppene som én klient er i.     

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

Vis gjeldende varsler.                                     

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

Vis nylig mislykkede jobber.                               

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

Vis arbeidsflytene i én policy (kalt WinFS i dette eksemplet).                   

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

Oppgi egenskapene for bare én saveset-forekomst (som definert av klientvertsnavn og lagringssett).      

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

INNLEGG:

Start en arbeidsflythandling.                                 

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

Opprett en ny klientforekomst (med standardverdier for alle egenskaper unntatt de fire som er oppført).           

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


Nødvendig informasjon for kundestøtte


Miljø:

  • Navn på NetWorker-server
  • NetWorker-versjon og buildnummer
  • NetWorker-serververtsoperativsystemtype og -versjon
Linux:
hostname
strings /usr/sbin/nsrd | grep -i "(#)"
cat /etc/*release
uname -a

Windows:

nsrwatch
Detaljer om problemet:
  • Forklar hvilken REST API-operasjon som utføres (GET, POST, PUT, DELETE), URI-en som brukes, eventuelt JSON-innhold (der det er aktuelt). 
  • REST API-svarkode og eventuell feilmelding som vises.
  • Har den første tilkoblingen og autorisasjonen vært vellykket mellom REST API-klienten og NetWorker?
Logg samling:
  • Gjengitt daemon.raw loggfil fra NetWorker-serveren:
  • REST API-logger fra NetWorker-serveren:  /nsr/logs/restapi (linux) eller EMC NetWorker\nsr\logs\restapi (Windows)
  • Hvis du har godkjenningsproblemer, kan du se standard NetWorker-godkjenningspålogging i /nsr/authc/logs (linux) eller .. \EMC NetWorker\nsr\authc-server\tomcat\logs (Windows)
Debug:
I mer komplekse problemer kan det være nødvendig med feilsøking i REST API. Feilsøking kan aktiveres som per NetWorker: Slik aktiverer du feilsøking i REST API

Ytelse
Hvis problemet er relatert til RESTAPI-ytelse, kan du bruke følgende alternativer til å spore ressursforbruket til nsrtomc+-prosessen som brukes av API-kall.

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

Disse utdataene viser standard topputdata, men med lesbare tidsstempler i mennesker. Dette kan brukes til å gjennomgå CPU- og minneforbruket ved hjelp av prosessen og hvor lenge det holdt seg i en bestemt tilstand når et REST-anrop ble foretatt. Dette kan sammenlignes med restapi.log- og AUTHC-loggene for å se hvilke anrop som ble foretatt og hvor ofte.
 

Windows: For Windows-servere må du installere noe sånt som "Performance Monitor:

1. Åpne Performance Monitor som administrator.
2. Fra venstre rute utvider du Overvåkingsverktøy og velger Ytelsesmåler.
3. Høyreklikk i høyre rute og velg Fjern alle tellere.
4. Høyreklikk i høyre rute og velg Legg til tellere.
5. Under Tilgjengelige tellere utvider du Minne, velger % utfør byte og klikker Legg til.6
. Velg Tilgjengelige byte under Minne,  og klikk Legg til.
7. Under Tilgjengelige tellere utviderdu Prosess og velger % prosessortid, og under Forekomster av valgt objekt velger du den første Java-oppføringen, klikker du Legg til.
8. Under Tilgjengelige tellere utviderdu Prosessorinformasjon og velger % prosessorverktøy ved å klikke på Legg til.
9. Tellerne som er lagt til i ruten til høyre, skal vise:

image.png

10. Klikk på OK. Høyreklikk på Ytelsesmåler, >og klikk på Nytt datainnsamlingssett.
11. Oppgi et navn, for eksempel: RESTAPI_MON.
12. Klikk Neste i skjermbildet for plassering,  med mindre du velger å angi en alternativ utdataplassering.
13. Velg Lagre og lukk, og klikk på Fullfør.
14. I den venstre ruten under Data Collector Sets-User> Defined åpner du egenskapene RESTAPI_MON og velger Kommadelt for loggformatet, klikker du OK.

image.png

15. I den venstre ruten under Data Collector Sets-User> Defined velger du RESTAPI_MON datainnsamlingssett og klikker Start (Spill av-knappen).
16. Hvis standard utdataplassering ble brukt, vises filen .csv under C:\PerfLogs\Admin\RESTAPI_MON.
17. Når problemet er observert og registrert i utdatafilen, kan du stoppe overvåkingsklikk ved å klikke Stopp under Datainnsamlingssett-Brukerdefinert.


Flere ressurser

Alle støttede REST API-endepunkter og brukseksempler er gitt i: Referanseveiledning for NetWorker REST API

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.