Prioriteringsmanual för NetWorker REST API
Summary: Den här kunskapsbasartikeln innehåller en översikt över grundläggande felsökning för RESTAPI-relaterade problem.
Instructions
Titta på YouTube
Additional Information
Komma igång
Representational State Transfer (REST) Application Programming Interface (API) ger programmatisk åtkomst till NetWorker-dataskyddstjänsten. Med hjälp av REST API kan NetWorker-användare skapa klientprogram för att automatisera NetWorker-åtgärder. NetWorker REST API installeras som en del av NetWorker-serverinstallationen i samma Apache tomcat-container som NetWorker-autentiseringstjänsterna. Autentiseringen görs med samma inloggningsuppgifter som används för NetWorker-hanteringskonsolen.
REST API tillåter interaktion med resurser som identifieras av URI-adresser (Uniform Resource Identifier). Den använder HTTP-verb (HEAD, GET, PUT, POST, DELETE) för att interagera med URI:n (Uniform Resource Identifier) på ett tillståndslöst sätt (servern innehåller inget klienttillstånd, varje meddelande är självbeskrivande).
Det här dokumentet handlar om interaktionen med NetWorker-resurser med hjälp av användarskrivna REST API-anrop. Ska inte förväxlas med REST API-anrop som används av NetWorker-backend-åtgärder.
Ansluta till NetWorker:
Det finns flera olika REST API-klienttekniker som kan användas för att köra kommandona för att ansluta till NetWorker. inklusive aktuellakommandon (Linux), PowerShell Invoke-WebRequest (Windows) och REST API-klientwebbläsartillägg.Det finns tre rubriker som behövs för anslutningen:
- Innehållstyp: application/json
- Acceptera: application/json
- Autentisering: Grundläggande med Base 64-kodat användarnamn och lösenord
I miljöer där flera NetWorker-datazoner autentiseras via en enda NetWorker AUTHC-server krävs ytterligare en rubrik:
- X-NW-AUTHC-BASE-URL:AUTHC_HOSTNAME_OR_IP:AUTHC_PORT
NetWorker REST API exponeras i följande bas-URI:
https://[nw-server-hostname]:9090/nwrestapi/Det finns olika versioner av API:er. Förbättringar har distribuerats sedan REST-API:et först implementerades. Till exempel:
https://[nw-server-hostname]:9090/nwrestapi/v1 https://[nw-server-hostname]:9090/nwrestapi/v2 https://[nw-server-hostname]:9090/nwrestapi/v3
Det fullständiga json-schemat finns på
https://[nw-server-hostname]:9090/nwrestapi/v3/schemas/swagger.json
| Framgångskod | Gäller för HTTP-metod | Innehåll i svarstext | Beskrivning |
| 200 | FÅ | Resursrepresentation. | OK. De åtgärder som resulterar i det här HTTP-tillståndet har resursrepresentationen i nyttolasten. |
| 201 | INLÄGG | Tomt svar. | Skapad. Den här statusen anger att en ny resurs eller ett avsett jobb har skapats och att dess associerade URL är tillgänglig från platsrubriken i svaret. |
| 202 | INLÄGG | Detaljer som svar på detta. | Accepterade. Detta indikerar att API-begäran har godkänts. Nyttolasten anger att URL:en till spårningsresursinstansen är tillgänglig från platsrubriken i svaret. |
| 204 | SÄTT/TA BORT | Tomt svar. | Inget innehåll. Tillståndet anger att den utförda åtgärden lyckades. Det finns dock inga ytterligare detaljer att lämna. |
| Felkod | Beskrivning |
| 400 | Felaktig begäran. |
| 401 | Ogiltiga autentiseringsuppgifter. |
| 403 | Otillräckliga privilegier. |
| 404 | Det gick inte att hitta resursen. |
| 405 | Metoden är inte tillåten. |
| 406 | Ogiltigt språk har angetts. |
| 500 | Internt serverfel. |
REST API-funktioner
| HTTP-metod | Åtgärd | Beskrivning |
| FÅ | Läsa | Hämtar resursrepresentationen. |
| INLÄGG | Skapa | Skapar en ny resurs. |
| SÄTTA | Uppdatera | Uppdaterar en befintlig resurs. |
| TA BORT | Ta bort | Tar bort en befintlig resurs. |
Några exempel:
GET
Visa en lista över alla klienter.
https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients
Endast en klient, som bara visar tre fält (hostname, saveSets och protectionGroups)
https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?fl=hostname,saveSets,protectionGroups&q=hostname:nwserver121
Visa en lista över de skyddsgrupper som en klient finns i.
https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?fl=protectionGroups&q=hostname:nwserver121
Visa aktuella varningar.
https://[nw-server-hostname]:9090/nwrestapi/v3/global/alerts
Visa de senaste misslyckade jobben.
https://[nw-server-hostname]:9090/nwrestapi/v3/global/jobs?q=completionStatus:"Failed"&fl=clientHostname,startTime,name,message
Visa en lista över arbetsflödena i en princip (med namnet WinFS i det här exemplet).
https://[nw-server-hostname]:9090/nwrestapi/v3/global/protectionpolicies/WinFS/workflows
Visa endast en lista över egenskaperna för en saveset-instans (enligt definitionen i klientens värdnamn och sparuppsättning).
https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients?q=hostname:vm-lego-231 and saveSets:"/etc"
INLÄGG:
Starta en arbetsflödesåtgärd.
https://[nw-server-hostname]:9090/nwrestapi/v3/global/protectionpolicies/Angela/workflows/WinFS/op/backup
JSON Body:
{
}
Skapa en ny klientinstans (med standardvärden för alla egenskaper utom de fyra i listan).
https://[nw-server-hostname]:9090/nwrestapi/v3/global/clients
JSON Body
{
"hostname": "vm-lego-231",
"backupType": "Filesystem",
"saveSets": [ "/etc" ],
"protectionGroups" : [ "LinuxFS" ]
Obligatorisk information för support
Miljö:
- NetWorker-servernamn
- NetWorker-version och build-nummer
- Typ och version av NetWorker-värdoperativsystemet
hostname
strings /usr/sbin/nsrd | grep -i "(#)"
cat /etc/*release
uname -a
Windows:
nsrwatch
- Förklara vilken REST API-åtgärd som utförs (GET, POST, PUT, DELETE), den URI som används, eventuellt JSON-brödtextinnehåll (om tillämpligt).
- REST API-svarskod och eventuella felmeddelanden.
- Har den första anslutningen och auktoriseringen lyckats mellan REST API-klienten och NetWorker?
- Återges daemon.raw loggfil från NetWorker-servern:
- Linux: /nsr/logs/daemon.raw
- Windows: C:\Program Files\EMC NetWorker\nsr\logs\daemon.raw
- NetWorker: Så här använder du nsr_render_log
- REST API-loggar från NetWorker-servern: /nsr/logs/restapi (Linux) eller EMC NetWorker\nsr\logs\restapi (Windows)
- Information om autentiseringsproblem finns i standardinloggning för NetWorker-autentisering i /nsr/authc/logs (Linux) eller .. \EMC NetWorker\nsr\authc-server\tomcat\logs (Windows)
Prestanda
Om problemet är RESTAPI-prestandarelaterat kan du använda följande alternativ för att spåra resursförbrukningen för nsrtomc+-processen som används av API-anrop.
Linux:
top -b | awk '/nsrtomc+/ {print strftime("%Y-%m-%d-%H:%M:%S", systime()), $0}'
Dessa utdata visar topputdata av standardtyp, men med tidsstämplar som kan läsas av människor. Detta kan användas för att granska processor- och minnesförbrukningen efter processen och hur länge den stannade i ett visst tillstånd när ett REST-anrop gjordes. Detta kan jämföras med restapi.log- och AUTHC-loggarna för att se vilka anrop som har gjorts och hur ofta.
Windows: För Windows-servrar måste du installera något i stil med "Prestandaövervakaren:
1. Öppna Prestandaövervakaren som administratör.
2. I den vänstra rutan expanderar du Övervakningsverktyg och väljer Prestandaövervakaren.
3. Högerklicka i den högra rutan och välj Ta bort alla räknare.
4. Högerklicka i den högra rutan och välj Lägg till räknare.
5. Under Tillgängliga räknare expanderar du Minne, väljer % Commit Bytes och klickar på Add.6
. Under Minne väljer du Tillgängliga byte och klickar på Lägg till.
7. Under Available Counters expanderardu Process och väljer % Processor Time och under Instances of Selected object väljer du den första Java-posten och klickar på Add.
8. Under Tillgängliga räknare expanderardu Processorinformation och väljer % processorverktyg och klickar på Lägg till.
9. De tillagda räknarna i den högra rutan bör visa:

10. Klicka på OK. Högerklicka på Prestandaövervakaren och klicka på New-Data> Collector Set.
11. Ange ett namn, t.ex.: RESTAPI_MON.
12. På platsskärmen klickar du på Nästa, såvida du inte väljer att ange en alternativ utdataplats.
13. Välj Spara och stäng och klicka på Slutför.
14. I den vänstra rutan under Data Collector Sets-User> Defined öppnar du RESTAPI_MON-egenskaperna och väljer Kommaavgränsad som loggformat och klickar på OK.

15. I den vänstra rutan under Data Collector Sets-User> Defined väljer du den RESTAPI_MON datainsamlaruppsättningen och klickar på Start (uppspelningsknapp).
16. Om standardutdataplatsen användes visas .csv-filen under C:\PerfLogs\Admin\RESTAPI_MON.
17. När problemet har observerats och registrerats i utdatafilen kan du stoppa övervakningsklicket genom att klicka på Stoppa under Data Collector Sets-User Defined.
Ytterligare resurser
Alla REST API-slutpunkter och användningsexempel som stöds finns i: NetWorker REST API-referensmanual