NetWorker REST API -luokitteluopas

Summary: Tämä tietämyskannan artikkeli sisältää yleiskatsauksen RESTAPI-ongelman perusvianmääritykseen.

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 -luokitteluopas

Katso YouTubessa

Additional Information

Aloittaminen


Representational State Transfer (REST) Application Programming Interface (API) tarjoaa ohjelmallisen pääsyn NetWorker-tietosuojapalveluun. REST APIn avulla NetWorker-käyttäjät voivat luoda asiakassovelluksia NetWorker-toimintojen automatisoimiseksi. NetWorker REST API asennetaan osana NetWorker-palvelimen asennusta samaan Apache tomcat -säilöön kuin NetWorker-todennuspalvelut. Todennus tehdään samoilla tunnistetiedoilla kuin NetWorker Management Consolessa.  

REST-ohjelmointirajapinta mahdollistaa vuorovaikutuksen URI (Uniform Resource Identifier) -osoitteiden tunnistamien resurssien kanssa. Se käyttää HTTP-verbejä (HEAD, GET, PUT, POST, DELETE) vuorovaikutukseen URI: n (Uniform Resource Identifier) kanssa tilattomalla tavalla (palvelin ei sisällä asiakkaan tilaa, jokainen viesti on itsekuvaava).

Tässä asiakirjassa käsitellään vuorovaikutusta NetWorker-resurssien kanssa käyttäjän kirjoittamien REST API -kutsujen avulla. Tätä ei pidä sekoittaa REST API -kutsuihin, joita NetWorker-taustatoiminnot käyttävät.
 

Yhteyden muodostaminen NetWorkeriin:

On olemassa useita erilaisia REST API -asiakastekniikoita, joita voidaan käyttää komentojen suorittamiseen yhteyden muodostamiseksi NetWorkeriin. mukaan lukien curl -komennot (Linux), PowerShell Invoke-WebRequest (Windows) ja REST API -asiakasselainlaajennukset. 

Yhteyden muodostamiseen tarvitaan kolme otsikkoa:   
  • Content-Type: application/json
  • Hyväksy: application/json
  • Valtuutus: Basic ja Base 64 koodattu käyttäjätunnus ja salasana

Ympäristöissä, joissa on useita NetWorker-tietovyöhykkeitä, jotka todennetaan yhden NetWorker AUTHC -palvelimen kautta, tarvitaan ylimääräinen otsikko:

  • X-NW-AUTHC-BASE-URL:AUTHC_HOSTNAME_OR_IP:AUTHC_PORT
AUTHC-oletusportti on portti 9090. Tämän otsikon käyttö on kuvattu yksityiskohtaisesti: RESTAPI: Kuinka käyttää AUTHC-etäpalvelinta RESTAPI-pyyntöjä käsiteltäessä?

NetWorker REST -ohjelmointirajapinta näkyy seuraavassa perus-URI:ssa:

https://[nw-server-hostname]:9090/nwrestapi/
API-rajapinnoista on olemassa erilaisia versioita. Parannuksia on otettu käyttöön REST-ohjelmointirajapinnan käyttöönoton jälkeen. Esimerkki:
https://[nw-server-hostname]:9090/nwrestapi/v1
https://[nw-server-hostname]:9090/nwrestapi/v2
https://[nw-server-hostname]:9090/nwrestapi/v3
Näihin päätepisteisiin tehdyt muutokset on kuvattu yksityiskohtaisesti: https://developer.dell.com/apis/2378/versions/v3/docs/GettingStarted.md

Koko json-rakenne on saatavilla osoitteessa

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

REST API -vastauskoodit:
 
Onnistumisen vastauskoodit
Onnistumisen koodi Koskee seuraavaa: HTTP-menetelmä Vastauksen leipäteksti Kuvaus
200 SAADA Resurssien edustus. OK. Tähän HTTP-tilaan johtavat toiminnot kantavat resurssin esityksen hyötykuormassa.
201 VIESTI Tyhjä vastaus. Luotu. Tämä tila ilmaisee, että uusi resurssi tai aiottu työ on luotu ja siihen liittyvä URL-osoite on käytettävissä vastauksen sijaintiotsikosta.
202 VIESTI Tiedot vastauksena. Hyväksytty. Tämä osoittaa, että API-pyyntö on hyväksytty. Tietosisältö ilmaisee, että seurantaresurssi-ilmentymän URL-osoite on käytettävissä vastauksen sijaintiotsikosta.
204 LAITA/POISTA Tyhjä vastaus. Ei sisältöä. Tila ilmaisee, että suoritettu toiminto onnistui. Tarkempia tietoja ei kuitenkaan tarvitse antaa.
 
Virhevastauskoodit
Virhekoodi Kuvaus
400 Virheellinen pyyntö.
401 Virheelliset tunnistetiedot.
403 Oikeudet eivät riitä.
404 Resurssia ei löydy.
405 Menetelmä ei ole sallittu.
406 Virheellinen kielialue on määritetty.
500 Internal Server Error.


REST API -funktiot

Tuetut HTTP-menetelmät
HTTP-menetelmä Toiminto Kuvaus
SAADA Read Hakee resurssiesityksen.
VIESTI Create Luo uuden resurssin.
LAITTAA Päivitys Päivittää aiemmin luodun resurssin.
DELETE Poista Poistaa aiemmin luodun resurssin.


Esimerkkejä:

GET

 

Lisää kaikki asiakkaat.                                            

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

Vain yksi asiakasohjelma, jossa näkyy vain kolme kenttää (isäntänimi, saveSets ja protectionGroups)      

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

Näytä luettelo suojausryhmistä, joihin yksi asiakas kuuluu.     

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

Näytä nykyiset hälytykset.                                     

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

Näytä äskettäin epäonnistuneet työt.                               

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

Luettele työnkulut yhdessä käytännössä (tässä esimerkissä WinFS ).                   

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

Näytä luettelo vain yhden saveset-esiintymän ominaisuuksista (asiakkaan isäntänimen ja tallennusjoukon määrittämällä tavalla).      

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

VIESTI:

Aloita työnkulkutoiminto.                                 

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

Luo uusi asiakasesiintymä (jossa oletusarvot ovat kaikille muille ominaisuuksille paitsi neljälle luetellulle).           

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


Tuen edellyttämät tiedot


Ympäristö:

  • NetWorker-palvelimen nimi
  • NetWorker-version ja koontiversion numero
  • NetWorker-palvelimen isäntäkäyttöjärjestelmän tyyppi ja versio
Linux:
hostname
strings /usr/sbin/nsrd | grep -i "(#)"
cat /etc/*release
uname -a

Windows:

nsrwatch
Ongelman tiedot:
  • Selitä, mitä REST API -toimintoa suoritetaan (GET, POST, PUT, DELETE), käytetty URI, JSONin leipätekstin sisältö (tarvittaessa). 
  • REST API -vastauskoodi ja mahdolliset virheilmoitukset.
  • Onko alkuperäinen yhteys ja valtuutus REST API -asiakkaan ja NetWorkerin välillä onnistunut?
Lokien kerääminen:
  • Hahmonnettu daemon.raw lokitiedosto NetWorker-palvelimesta:
  • REST API -lokit NetWorker-palvelimesta:  /nsr/logs/restapi (linux) tai EMC NetWorker\nsr\logs\restapi (Windows)
  • Jos sinulla on todennusongelmia, katso NetWorkerin vakiotodennuslokiin kirjaaminen hakemistossa /nsr/authc/logs (linux) tai .. \EMC NetWorker\nsr\authc-server\tomcat\logs (Windows)
Debug:
Monimutkaisemmissa ongelmissa voidaan tarvita REST API -virheenkorjausta. Virheenkorjaus voidaan ottaa käyttöön seuraavasti: NetWorker: REST API -virheenkorjauksen ottaminen käyttöön

Suorituskykyä
Jos ongelma liittyy RESTAPIn suorituskykyyn, voit seurata API-kutsujen käyttämän nsrtomc+-prosessin resurssien kulutusta seuraavien asetusten avulla.

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

Tämä tulos näyttää tavallisen ylätuloksen, mutta siinä on ihmisen luettavissa olevat aikaleimat. Sen avulla voidaan tarkastella suorittimen ja muistin kulutusta prosessin mukaan ja kuinka kauan se pysyi tietyssä tilassa, kun REST-kutsu soitettiin. Tätä voidaan verrata restapi.log- ja AUTHC-lokeihin, jotta näet, mitä puheluita soitettiin ja kuinka usein.
 

Windows: Windows-palvelimille sinun on asennettava jotain "Performance Monitor:

1. Avaa suorituskyvyn valvonta järjestelmänvalvojana.
2. Laajenna vasemmasta ruudusta Valvontatyökalut ja valitse Suorituskyvyn valvonta.
3. Napsauta hiiren kakkospainikkeella oikeassa ruudussa ja valitse Poista kaikki laskurit.
4. Napsauta hiiren kakkospainikkeella oikeassa ruudussa ja valitse Lisää laskureita.
5. Laajenna Käytettävissä olevat laskurit -kohdassa Muisti, valitse % Vahvista tavuja ja valitse Lisää.6
. Valitse Memory-kohdassa Available Bytes ja Add.
7. Laajenna Käytettävissä olevat laskurit -kohdassa Prosessi ja valitse % suorittimen ajasta ja valitse Valitun objektin esiintymät -kohdassa ensimmäinen Java-merkintä ja valitse Lisää.
8. Laajenna Käytettävissä olevat laskurit-kohdassa Suorittimen tiedot ja valitse % Processor Utility, klikkaa Lisää.
9. Oikeanpuoleisen ruudun lisätyissä laskureissa pitäisi näkyä:

image.png

10. Valitse OK. Napsauta hiiren kakkospainikkeella Suorituskyvyn valvonta ja valitse New-Data> Collector Set.
11. Anna nimi, esimerkiksi: RESTAPI_MON.
12. Valitse sijaintinäytössä Seuraava,  ellet määritä vaihtoehtoista tulostussijaintia.
13. Valitse Tallenna ja sulje ja napsauta Valmis.
14. Avaa vasemmanpuoleisen ruudun kohdassa Data Collector Sets-User> DefinedRESTAPI_MON ominaisuudet ja valitse lokimuodoksi Pilkuilla eroteltu. Valitse OK.

image.png

15. Valitse vasemmanpuoleisesta ruudusta Data Collector Sets-User> Defined -kohdasta RESTAPI_MON tiedonkeruutyökalujen joukko ja napsauta Käynnistä (toistopainike).
16. Jos käytettiin oletusarvoista tulostussijaintia, .csv tiedosto näkyy kansiossa C:\PerfLogs\Admin\RESTAPI_MON.
17. Kun ongelma on havaittu ja tallennettu tulostiedostoon, voit lopettaa napsautuksen seurannan napsauttamalla Pysäytä kohdassa Data Collector Sets-User Defined.


Muita resursseja

Kaikki tuetut REST API -päätepisteet ja käyttöesimerkit ovat seuraavissa: NetWorker REST API -viiteopas

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.