PowerScale: Jak użyć polecenia curl, aby sprawdzić, czy interfejs API OneFS działa prawidłowo
Summary: Ten artykuł bazy wiedzy jest przydatny do rozwiązywania problemów z interfejsem programowania aplikacji (API) bezpośrednio w klastrze za pomocą poleceń curl. Użyj go, aby wykluczyć problemy ze skryptami niestandardowymi lub kodem aplikacji. ...
Instructions
Wprowadzenie
W przypadku wystąpienia problemu z interfejsem API OneFS przed przystąpieniem do rozwiązywania problemów należy sprawdzić, czy podstawowe operacje działają prawidłowo, uruchamiając polecenie curl . Ten artykuł zawiera instrukcje dotyczące używania polecenia curl do testowania operacji interfejsu API. Pomaga sprawdzić, czy uruchomione polecenie ma prawidłowy format.
Interfejs API OneFS składa się z dwóch obszarów funkcjonalnych:
- Interfejs API konfiguracji systemu (znany w OneFS 7.1.0 i wcześniejszych jako interfejs API platformy)
- Interfejs API dostępu do systemu plików (znany w OneFS 7.1.0 i wcześniejszych jako RESTful Access to the Namespace API lub RAN API)
Procedura
Użyj polecenia curl z poświadczeniami "root" podczas testowania interfejsu API konfiguracji systemu lub interfejsu API dostępu do systemu plików.
- Utwórz połączenie SSH na dowolnym węźle w klastrze i zaloguj się przy użyciu konta "root".
- Użyj polecenia curl zgodnie z opisem w poniższych sekcjach Interfejs API konfiguracji systemu lub Interfejs API dostępu do systemu plików .
- Jeśli problemy nadal występują, skontaktuj się z działem pomocy technicznej Isilon.
Aby uzyskać dodatkowe informacje na temat poleceń curl i składni, zobacz stronę podręcznika curl .
Aby uzyskać dodatkowe informacje na temat żądań interfejsu API konfiguracji systemu OneFS i oczekiwanej odpowiedzi, zapoznaj się z przewodnikiem referencyjnym API odpowiedniej wersji OneFS. Łącza do najpopularniejszych wersji OneFS: Interfejs API konfiguracji systemu OneFS 8.2.2.0, OneFS 9.1.0, OneFS 9.5.0.0 i OneFS 9.7.0.0
Typowe opcje curl z interfejsem API konfiguracji systemu
| Opcja | Opis |
|---|---|
| -d | Wysyła określone dane w żądaniu POST |
| -H | Określa dodatkowy nagłówek do użycia |
| -k | Umożliwia nawiązywanie połączeń z niezaufanymi witrynami SSL (w przypadku domyślnych certyfikatów SSL Isilon z podpisem własnym) |
| -u | Nazwa użytkownika do uwierzytelniania Podczas uruchamiania polecenia zostanie wyświetlony monit o podanie hasła dla tego użytkownika |
| -v | Określa pełne dane wyjściowe |
| -X | Określa metodę żądania (GET, PUT,POST itd.) |
Typowe użycie polecenia curl w interfejsie API konfiguracji systemu
Poniżej przedstawiono przykłady typowych poleceń curl . Postępuj zgodnie z podobną składnią dla akcji, którą chcesz wykonać.
- Pobieranie informacji (polecenia GET):
Składnia ogólna: Użyj poniższego, gdzie <username> to nazwa użytkownika, a <URL> to adres URL węzła, z którym się łączysz.# curl -vk -u "<username>" -H 'Content-type:application/json' -X GET '<URL>'
Na przykład, aby uzyskać listę udziałów bloku komunikatów serwera (SMB), polecenie wygląda podobnie do następującego:# curl -vk -u "root" -H 'Content-type:application/json' -X GET 'https://10.11.1.1:8080/platform/1/protocols/smb/shares'
- Wysyłanie informacji (polecenia POST lub PUT):
Składnia ogólna: Użyj następującego polecenia, gdzie <username> to nazwa użytkownika, <json-data> to ciąg w formacie JSON, a <URL> to adres URL węzła, z którym się łączysz.# curl -vk -u <username> -H 'Content-type:application/json' -X POST -d '<json-data>' <URL>
Na przykład, aby utworzyć nowy udział SMB o nazwie papi-example ze ścieżką /ifs/papi-example, polecenie wygląda podobnie do następującego:# 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'
Interfejs API dostępu do systemu plików
Typowe opcje curl z interfejsem API dostępu do systemu plików
| Opcja | Opis |
|---|---|
| -d | Wysyła określone dane w żądaniu POST |
| --data-binary | Określa położenie pliku binarnego |
| -H | Określa dodatkowy nagłówek do użycia |
| -k | Umożliwia łączenie się z niezaufanymi witrynami SSL (domyślnymi certyfikatami SSL Isilon z podpisem własnym). |
| -u | Na potrzeby uwierzytelnienia zostanie wyświetlony monit o podanie hasła dla tego użytkownika. |
| -v | Określa pełne dane wyjściowe |
| -X | Określa metodę żądania (GET, PUT,POST itd.) |
Typowe użycie curl z interfejsem API dostępu do systemu plików
Poniżej przedstawiono przykłady typowych poleceń curl . Postępuj zgodnie z podobną składnią, aby wykonać akcję.
NUTA
Własne przestrzenie nazw można tworzyć za pomocą interfejsu API dostępu do systemu plików, ale do weryfikacji należy użyć domyślnej przestrzeni nazw. Domyślna przestrzeń nazw to /namespace/ifs.
- Pobieranie informacji (polecenia GET):
Składnia ogólna:# curl -vk -u "<username>" -X GET 'https://<node_IP>:8080/namespace/<access_point>'
Na przykład, aby uzyskać listę zawartości /ifs:# curl -vk -u "root" -X GET 'https://10.11.1.1:8080/namespace/ifs'
- Wysyłanie informacji (polecenia POST lub PUT):
Składnia ogólna: Użyj poniższego, używając poprawnego dla zmiennej <zawartości nagłówka>. Aby uzyskać informacje na temat nagłówka<> zawartości, zapoznaj się z podręcznikiem API 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>'
Na przykład, aby skopiować plik danych z /tmp/testfile.jpg do /ifs/papi-example, polecenie wygląda podobnie do następującego:
# 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'
Wszystkie powyższe polecenia używają podstawowego uwierzytelniania HTTP do uruchamiania zapytań interfejsu API.