PowerScale: Jak pomocí příkazu curl ověřit, zda rozhraní API systému OneFS funguje správně

Summary: Tento článek znalostní databáze je užitečný při odstraňování problémů s rozhraním API (Application Programming Interface) v clusteru přímo pomocí příkazů curl. Použijte ho k vyloučení problémů s vlastními skripty nebo kódem aplikace. ...

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.
Check out other resources

Instructions

Úvod

Pokud narazíte na problém s rozhraním API systému OneFS, ověřte, zda základní operace fungují správně, spuštěním příkazu curl , než budete provádět další odstraňování problémů. Tento článek obsahuje pokyny k použití příkazu curl k testování operací rozhraní API. Pomáhá ověřit, zda je spuštěný příkaz ve správném formátu.

Rozhraní API systému OneFS se skládá ze dvou funkčních oblastí:

  • Rozhraní API pro konfiguraci systému (známé v systému OneFS 7.1.0 a starších jako rozhraní API platformy)
Tato oblast umožňuje konfigurovat, spravovat a monitorovat cluster.
  • Rozhraní API pro přístup k systému souborů (známé v systému OneFS 7.1.0 a starších jako RESTful přístup k rozhraní API oboru názvů nebo RAN API)
Tato oblast umožňuje operace se soubory a adresáři v clusteru.


Postup

Při testování rozhraní API pro konfiguraci systému nebo rozhraní API pro přístup k systému použijte příkaz curl s přihlašovacími údaji "root".

  1. O Navažte připojení SSH na libovolném uzlu v clusteru a přihlaste se pomocí účtu "root".
  2. Použijte příkaz curl , jak je popsáno v níže uvedených částech rozhraní API pro konfiguraci systému nebo rozhraní API pro přístup k systému souborů . 
  3. Pokud problémy přetrvávají, obraťte se na technickou podporu Isilon.

Další informace o příkazech a syntaxi curl najdete na manuálové stránce curl .

Další informace o požadavcích rozhraní API konfigurace systému OneFS a očekávané odezvě naleznete v referenční příručce k rozhraní API příslušné verze systému OneFS. Odkazy pro nejběžnější verze systému OneFS: Rozhraní API pro konfiguraci systému OneFS 8.2.2.0, OneFS 9.1.0, OneFS 9.5.0.0 a OneFS 9.7.0.0

Běžné možnosti příkazu curl s rozhraním API pro konfiguraci systému 

Možnost Popis
-d  Odešle zadaná data v požadavku POST
-H Určuje další hlavičku, která se má použít
-k Umožňuje připojení k nedůvěryhodným webům SSL (pro výchozí certifikáty SSL Isilon podepsané držitelem)
-u Uživatelské jméno pro ověřování Při spuštění příkazu budete vyzváni k zadání hesla pro tohoto uživatele
-v Určuje podrobný výstup.
-X  Určuje metodu požadavku (GET, PUT, POST atd.)

 

Běžné použití curl s rozhraním API pro konfiguraci systému

Níže jsou uvedeny příklady běžných příkazů curl . Postupujte podle podobné syntaxe pro akci, kterou chcete provést.

  • Načítání informací (příkazy GET):

    Obecná syntaxe: Použijte následující, kde <username> je uživatelské jméno a <URL> je adresa URL uzlu, ke kterému se připojujete. 
    # curl  -vk  -u "<username>" -H 'Content-type:application/json' -X GET '<URL>'


    Chcete-li například získat seznam sdílených složek SMB (Server Message Block), vypadá příkaz podobně jako v následujícím příkladu: 
    # curl -vk -u "root" -H 'Content-type:application/json' -X GET 'https://10.11.1.1:8080/platform/1/protocols/smb/shares'

     
  • Odesílání informací (příkazy POST nebo PUT):

    Obecná syntaxe: Použijte následující, kde <username> je uživatelské jméno, <json-data> je řetězec ve formátu JSON a <URL> je adresa URL uzlu, ke kterému se připojujete. 
    # curl  -vk  -u <username> -H 'Content-type:application/json' -X POST  -d '<json-data>' <URL>



    Pokud například chcete vytvořit novou sdílenou složku SMB s názvem papi-example s cestou /ifs/papi-example, příkaz vypadá podobně jako v následujícím příkladu: 
    # curl -vk -u root -H "Content-type: application/json" -X POST -d '{ "name" : "papi-example", "path" : "/ifs/papi-example" }' 'https://10.11.1.1:8080/platform/1/protocols/smb/shares'

Rozhraní API pro přístup k systému souborů

Běžné možnosti curl s rozhraním API pro přístup k systému souborů

Možnost Popis
-d  Odešle zadaná data v požadavku POST
--data-binární Určuje umístění binárního souboru
-H Určuje další hlavičku, která se má použít
-k Umožňuje připojení k nedůvěryhodným webům SSL (výchozí certifikáty SSL Isilon podepsané držitelem).
-u Uživatelské jméno pro ověření, budete vyzváni k zadání hesla pro tohoto uživatele.
-v Určuje podrobný výstup. 
-X  Určuje metodu požadavku (GET, PUT, POST atd.)

 

Běžné použití curl s rozhraním API pro přístup k systému souborů

Níže jsou uvedeny příklady běžných příkazů curl . Postupujte podle podobné syntaxe pro akci, která se má provést.

POZNÁMKA
Vlastní obory názvů můžete vytvořit prostřednictvím rozhraní API pro přístup k systému souborů, ale pro ověření byste měli použít výchozí obor názvů. Výchozí obor názvů je /namespace/ifs.

  • Načítání informací (příkazy GET):

    Obecná syntaxe: 
    # curl -vk -u "<username>" -X GET 'https://<node_IP>:8080/namespace/<access_point>'



    Chcete-li například získat výpis obsahu /ifs: 
    # curl -vk -u "root" -X GET 'https://10.11.1.1:8080/namespace/ifs'

 

  • Odesílání informací (příkazy POST nebo PUT):

    obecná syntaxe: Použijte následující s použitím správného pro hlavičku> proměnného< obsahu. Informace o <záhlaví> obsahu naleznete v referenční příručce k rozhraní API systému OneFS 
    # curl -vk -u "<username>" -H "<content header>" --data-binary @<source file path> -X PUT 'https://<node_IP>:8080/namespace/<access_point>/<destination file path>'


            Chcete-li například zkopírovat datový soubor z umístění /tmp/testfile.jpg do složky /ifs/papi-example, příkaz vypadá podobně jako v následujícím příkladu:

# curl -vk -u "root" -H "x-isi-ifs-target-type:object" --data-binary @/tmp/testfile.jpg -X PUT 'https://<node_IP>:8080/namespace/ifs/papi-example/testfile.jpg'



Všechny výše uvedené příkazy používají ke spouštění dotazů rozhraní API základní ověřování HTTP. 

Affected Products

PowerScale OneFS

Products

PowerScale OneFS
Article Properties
Article Number: 000011287
Article Type: How To
Last Modified: 08 Oct 2025
Version:  8
Find answers to your questions from other Dell users
Support Services
Check if your device is covered by Support Services.