NetWorker REST API Önceliklendirme Rehberi

Summary: Bu KB, RETAPI ile ilgili sorunlar için temel sorun gidermeye genel bir bakış sağlar.

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 Önceliklendirme Rehberi

YouTube'da izleyin

Additional Information

Başlarken


Temsili Durum Aktarımı (REST) Uygulama Programlama Arayüzü (API), NetWorker veri koruma hizmetine programlı erişim sağlar. NetWorker kullanıcıları, REST API'yi kullanarak NetWorker işlemlerini otomatikleştirmek için istemci uygulamaları oluşturabilir. NetWorker REST API, NetWorker kimlik doğrulama hizmetleriyle aynı Apache Tomcat kapsayıcısına NetWorker sunucu kurulumunun bir parçası olarak kurulur. Kimlik doğrulaması, NetWorker Management Console için kullanılanla aynı kimlik bilgileri kullanılarak yapılır.  

REST API, Tekdüzen Kaynak Tanımlayıcısı (URI) adresleriyle tanımlanan kaynaklarla etkileşime olanak tanır. Tekdüzen Kaynak Tanımlayıcısı (URI) ile durum bilgisi olmayan bir şekilde etkileşim kurmak için HTTP fiillerini (HEAD, GET, PUT, POST, DELETE) kullanır (sunucu istemci durumu içermez, her ileti kendi kendini açıklayıcıdır).

Bu belge, kullanıcı tarafından yazılan REST API çağrılarını kullanarak NetWorker kaynaklarıyla etkileşimi ele alır. Arka uç NetWorker işlemleri tarafından kullanılan REST API çağrıları ile karıştırılmamalıdır.
 

NetWorker a bağlanma:

NetWorker'a bağlanmak için komutları çalıştırmak üzere kullanılabilecek birkaç farklı REST API istemci teknolojisi vardır; curl komutları (Linux), PowerShell Invoke-WebRequest (Windows) ve REST API istemci tarayıcı uzantıları dahil. 

Bağlantı için gereken üç başlık vardır:   
  • Content-Type: application/json
  • Accept: application/json
  • Yetkilendirme: Base 64 ile kodlanmış kullanıcı adı ve parolaya sahip Basic

Tek bir NetWorker AUTHC sunucusu üzerinden kimlik doğrulaması yapan birden fazla NetWorker verizone bulunan ortamlarda ek bir başlık gerekir:

  • X-NW-AUTHC-BASE-URL:AUTHC_HOSTNAME_OR_IP:AUTHC_PORT
Varsayılan AUTHC bağlantı noktası 9090 numaralı bağlantı noktasıdır. Bu başlığın kullanımı şurada detaylandırılmıştır: RESTAPI: RESTAPI isteklerini işlerken uzak bir AUTHC sunucusu nasıl kullanılır?

NetWorker REST API, aşağıdaki temel URI'de gösterilir:

https://[nw-server-hostname]:9090/nwrestapi/
API'lerin farklı sürümleri vardır. REST API'nin ilk kez uygulanmasından bu yana geliştirmeler yapılmıştır. Örneğin:
https://[nw-server-hostname]:9090/nwrestapi/v1
https://[nw-server-hostname]:9090/nwrestapi/v2
https://[nw-server-hostname]:9090/nwrestapi/v3
Bu uç noktalarda yapılan değişiklikler şurada ayrıntılı olarak açıklanmıştır: https://developer.dell.com/apis/2378/versions/v3/docs/GettingStarted.md

Tam json şeması şu adreste bulunabilir:

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

REST API Yanıt Kodları:
 
Başarı Yanıt Kodları
Başarı Kodu Şunlar için geçerlidir: HTTP yöntemi Yanıt Gövdesi İçeriği Açıklama
200 AL Kaynak Gösterimi. Tamam. Bu HTTP durumuna neden olan işlemler, yükte kaynak gösterimini taşır.
201 YAYINLA Boş Yanıt. Oluşturulan. Bu durum, yeni bir kaynağın veya amaçlanan bir işin oluşturulduğunu ve ilişkili URL'sine yanıttaki konum başlığından erişilebildiğini gösterir.
202 YAYINLA Ayrıntılar yanıtta. Kabul. Bu, API isteğinin kabul edildiğini gösterir. Yük, izleme kaynağı örneğinin URL'sine yanıttaki konum başlığından erişilebildiğini belirtir.
204 KOY/Sil Boş Yanıt. İçerik Yok. Durum, gerçekleştirilen işlemin başarılı olduğunu gösterir. Ancak, sağlanacak ek ayrıntı yoktur.
 
Hata Yanıt Kodları
Hata Kodu Açıklama
400 Hatalı İstek.
401 Geçersiz Kimlik Bilgileri.
403 Yetersiz Ayrıcalıklar.
404 Kaynak bulunamadı.
405 Yönteme İzin Verilmiyor.
406 Geçersiz Yerel Ayar Belirtildi.
500 Internal Server Error.


REST API İşlevleri

Desteklenen HTTP Yöntemleri
HTTP Yöntemi İşlem Açıklama
AL Read Kaynak gösterimini alır.
YAYINLA Oluşturma Yeni bir kaynak oluşturur.
KOYMAK Güncelleştirme Var olan bir kaynağı güncelleştirir.
DELETE Çıkarma Mevcut bir kaynağı siler.


Bazı örnekler:

GET

 

Tüm istemcileri listele.                                            

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

Yalnızca bir istemci, yalnızca üç alan (hostname, saveSets ve protectionGroups) gösterir      

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

Bir istemcinin içinde bulunduğu Protection Groups öğesini listeleyin.     

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

Mevcut uyarıları gösterir.                                     

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

Son başarısız işleri gösterir.                               

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

İş akışlarını tek bir ilkede listeleyin (bu örnekte WinFS olarak adlandırılmıştır).                   

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

Yalnızca tek bir kayıt kümesi örneğinin özelliklerini listeleyin (istemci ana bilgisayar adı ve kaydetme kümesi tarafından tanımlandığı gibi).      

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

YAYINLA:

Bir iş akışı eylemi başlatın.                                 

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

Yeni bir istemci örneği oluşturun (listelenen dört özellik dışındaki tüm özellikler için varsayılan değerlerle).           

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


Destek İçin Gerekli Bilgiler


Ortam:

  • NetWorker sunucu adı
  • NetWorker sürümü ve derleme numarası
  • NetWorker sunucu ana bilgisayar işletim sistemi türü ve sürümü
Linux:
hostname
strings /usr/sbin/nsrd | grep -i "(#)"
cat /etc/*release
uname -a

Windows:

nsrwatch
Sorun Ayrıntıları:
  • Hangi REST API işleminin gerçekleştirildiğini (GET, POST, PUT, DELETE), kullanılan URI'yi ve JSON gövde içeriğini (varsa) açıklayın. 
  • REST API yanıt kodu ve sağlanan herhangi bir hata mesajı.
  • REST API istemcisi ile NetWorker arasında ilk bağlantı ve yetkilendirme başarılı oldu mu?
Günlük Toplama:
  • NetWorker sunucusundan işlenen daemon.raw günlük dosyası:
  • NetWorker sunucusundan alınan REST API günlükleri:  /nsr/logs/restapi (linux) veya EMC NetWorker\nsr\logs\restapi (Windows)
  • Kimlik doğrulama sorunları için /nsr/authc/logs (linux) veya .'deki standart NetWorker kimlik doğrulama günlüğüne bakın. \EMC NetWorker\nsr\authc-server\tomcat\logs (Windows)
Hata ayıklama:
Daha karmaşık sorunlarda REST API hata ayıklaması gerekebilir. Hata ayıklama şu şekilde etkinleştirilebilir: NetWorker: REST API Hata Ayıklamasını Etkinleştirme

Performans
Sorun RESTAPI performansıyla ilgiliyse, API çağrıları tarafından kullanılan nsrtomc+ işleminin kaynak tüketimini izlemek için aşağıdaki seçenekleri kullanabilirsiniz.

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

Bu çıktı, insanlar tarafından okunabilir zaman damgalarına sahip standart üst çıktıyı gösterir. Bu, işlem tarafından CPU ve bellek tüketimini ve bir REST çağrısı yapıldığında belirli bir durumda ne kadar kaldığını gözden geçirmek için kullanılabilir. Bu, hangi aramaların ne sıklıkta yapıldığını görmek için restapi.log ve AUTHC günlükleriyle karşılaştırılabilir.
 

Windows: Windows sunucuları için "Performans İzleyicisi:

1. Performans İzleyicisi'ni yönetici olarak açın.
2. Sol bölmeden İzleme Araçları'nı genişletin ve Performans İzleyicisi'ni seçin.
3. Sağ bölmenin içine sağ tıklayın ve Tüm Sayaçları Kaldır'ı seçin.
4. Sağ bölmenin içine sağ tıklayın ve Sayaç Ekle'yi seçin.
5. Kullanılabilir Sayaçlar'ın altında Bellek'i genişletin ve İşlemi Bayt Yüzdesi'ni seçin ve Ekle'ye tıklayın.6
. Memory altında, Available Bytes öğesini seçin ve Add öğesine tıklayın.
7. Kullanılabilir Sayaçlar'ın altında İşlem'i genişletin ve % İşlemci Süresi'ni seçin ve Seçili nesnenin Örnekleri'nin altında ilk Java girişini seçin, Ekle'yi tıklatın.
8. Kullanılabilir Sayaçlar altında İşlemci Bilgileri'ni genişletin ve % İşlemci Yardımcı Programı'nı seçin, Ekle'ye tıklayın.
9. Sağ bölmedeki Eklenen sayaçlar şunları göstermelidir:

image.png

10. Tamam'a tıklayın. Performans İzleyicisi'ni sağ tıklatın ve Yeni Veri Toplayıcı Grubu'nu> tıklatın.
11. Bir ad girin, örneğin: RESTAPI_MON.
12. Alternatif bir çıktı konumu belirtmeyi seçmediğiniz sürece konum ekranında İleri  öğesine tıklayın.
13. Kaydet ve Kapat ı seçin ve Son a tıklayın.
14. Veri Toplayıcı Setleri-Kullanıcı> Tanımlı altındaki sol bölmede RESTAPI_MON özelliklerini açın ve günlük biçimi için Virgülle Ayrılmış öğesini seçin, Tamam a tıklayın.

image.png

15. Sol bölmede , Veri Toplayıcı Grupları-Kullanıcı Tanımlı'nın>altında, RESTAPI_MON veri toplayıcı kümesini seçin ve Başlat'ı tıklatın (Oynat düğmesi).
16. Varsayılan çıktı konumu kullanıldıysa .csv dosyası C:\PerfLogs\Admin\RESTAPI_MON altında görünür.
17. Sorun gözlemlendikten ve çıktı dosyasına kaydedildikten sonra, Veri Toplayıcı Grupları-Kullanıcı Tanımlı altındaki Durdur'u tıklatarak izlemeyi durdurabilirsiniz.


Diğer Kaynaklar

Desteklenen tüm REST API uç noktaları ve kullanım örnekleri şurada sağlanır: NetWorker REST API Referans Rehberi

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.