Шкала потужності: Як використовувати команду curl, щоб переконатися, що API OneFS працює належним чином

Summary: Ця стаття бази знань корисна для вирішення проблем з інтерфейсом прикладного програмування (API) безпосередньо в кластері за допомогою команд curl. Використовуйте його, щоб виключити проблеми з користувацькими скриптами або кодом програми. ...

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

Введення

Якщо у вас виникне проблема з API OneFS, переконайтеся, що основні операції працюють належним чином, запустивши команду curl, перш ніж виконувати інші способи усунення несправностей. У цій статті наведено інструкції щодо використання команди curl для тестування операцій API. Це допомагає переконатися, що команда, яку ви виконуєте, має правильний формат.

OneFS API складається з двох функціональних областей:

  • API конфігурації системи (відомий в OneFS 7.1.0 і раніше як Platform API)
Ця область забезпечує функціональність конфігурації кластера, управління та моніторингу.
  • API доступу до файлової системи (відомий у OneFS 7.1.0 і раніших версіях як RESTful Access to the namespace API, або RAN API)
Ця область дозволяє виконувати операції з файлами та каталогами в кластері.


Процедура

Використовуйте команду curl з обліковими даними "root" під час тестування API конфігурації системи або API доступу до файлової системи.

  1. Oзапишіть SSH-з'єднання на будь-якому вузлі кластера та увійдіть за допомогою облікового запису "root".
  2. Використовуйте команду curl , як описано в розділах API конфігурації системи або API доступу до файлової системи нижче. 
  3. Якщо проблеми не зникають, зверніться до служби технічної підтримки Isilon.

Для отримання додаткової інформації про команди curl та синтаксис перегляньте сторінку curl man.

Щоб отримати додаткову інформацію про запити API конфігурації системи OneFS та очікувану відповідь, перегляньте довідковий посібник з API відповідної версії OneFS. Посилання на найпоширеніші версії OneFS: API конфігурації системи OneFS 8.2.2.0 , OneFS 9.1.0, OneFS 9.5.0.0 і OneFS 9.7.0.0

Загальні параметри curl з API конфігурації системи 

Варіант Опис
-д  Надсилає вказані дані в POST-запиті
-Ч Вказує додатковий заголовок для використання
-к Дозволяє підключення до ненадійних сайтів SSL (для самопідписаних SSL-сертифікатів Isilon за замовчуванням)
-у Ім'я користувача для автентифікації Під час виконання команди вам буде запропоновано вказати пароль для цього користувача
-v Визначає докладний вивід
-Х  Вказує метод запиту (GET,PUT,POST і так далі)

 

Поширене використання curl з API конфігурації системи

Нижче наведено приклади поширених команд curl . Дотримуйтесь подібного синтаксису для дії, яку ви хочете виконати.

  • Отримання інформації (команди GET):

    Загальний синтаксис: Використовуйте наступне, де <ім'я> користувача – це ім'я користувача, а <URL> – це URL-адреса вузла, до якого ви підключаєтеся. 
    # curl  -vk  -u "<username>" -H 'Content-type:application/json' -X GET '<URL>'


    Наприклад, щоб отримати список спільних ресурсів блоку повідомлень сервера (SMB), команда виглядає приблизно так: 
    # curl -vk -u "root" -H 'Content-type:application/json' -X GET 'https://10.11.1.1:8080/platform/1/protocols/smb/shares'

     
  • Відправка інформації (команди POST або PUT):

    Загальний синтаксис: Використовуйте наступне, де <ім'я> користувача – це ім'я користувача, <json-data> – це рядок у форматі JSON, а <URL> – це URL-адреса вузла, до якого ви підключаєтеся. 
    # curl  -vk  -u <username> -H 'Content-type:application/json' -X POST  -d '<json-data>' <URL>



    Наприклад, щоб створити новий спільний ресурс SMB під назвою papi-example зі шляхом /ifs/papi-example, команда виглядає приблизно так: 
    # 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'

API доступу до файлової системи

Загальні параметри curl з API доступу до файлової системи

Варіант Опис
-д  Надсилає вказані дані в POST-запиті
--data-binary Визначає розташування двійкового файлу
-Ч Вказує додатковий заголовок для використання
-к Дозволяє підключення до ненадійних сайтів SSL (сертифікати SSL Isilon за замовчуванням із самопідписом).
-у Ім'я користувача для автентифікації, вам буде запропоновано вказати пароль для цього користувача.
-v Визначає докладний вивід 
-Х  Вказує метод запиту (GET,PUT,POST і так далі)

 

Поширене використання curl з API доступу до файлової системи

Нижче наведено приклади поширених команд curl . Дотримуйтесь подібного синтаксису для дії, яку потрібно виконати.

ПРИМІТКА
Ви можете створювати власні простори імен через API доступу до файлової системи, але для перевірки слід використовувати простір імен за замовчуванням. За замовчуванням використовується простір назв /namespace/ifs.

  • Отримання інформації (команди GET):

    Загальний синтаксис: 
    # curl -vk -u "<username>" -X GET 'https://<node_IP>:8080/namespace/<access_point>'



    Наприклад, щоб отримати список вмісту /ifs: 
    # curl -vk -u "root" -X GET 'https://10.11.1.1:8080/namespace/ifs'

 

  • Надсилання інформації (команди POST або PUT):

    Загальний синтаксис: Використовуйте наступне, використовуючи правильний для змінної <заголовок> content. Інформацію про <заголовок> вмісту можна знайти в довідковому посібнику OneFS API 
    # curl -vk -u "<username>" -H "<content header>" --data-binary @<source file path> -X PUT 'https://<node_IP>:8080/namespace/<access_point>/<destination file path>'


            Наприклад, щоб скопіювати файл даних з /tmp/testfile.jpg до /ifs/papi-example, команда виглядає приблизно так:

# 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'



Усі перераховані вище команди використовують базову аутентифікацію HTTP для виконання запитів API. 

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.