PowerScale：如何使用 curl 命令確認 OneFS API 是否正常運作

Summary: 本知識文章有助於直接使用 curl 命令針對叢集的應用程式發展介面 （API） 問題進行故障診斷。使用它來排除自定義腳本或應用程式代碼的問題。

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

簡介

當您遇到 OneFS API 問題時，請先執行 curl 命令，確認基本作業正常運作，然後再進行其他故障診斷。本文提供使用 curl 命令測試 API 作業的說明。它有助於驗證您正在運行的命令是否採用正確的格式。

OneFS API 由兩個功能區域組成：

  • 系統組態 API （在 OneFS 7.1.0 及更舊版本中稱為平台 API）
此區域可提供叢集組態、管理和監控功能。
  • 檔案系統存取 API （在 OneFS 7.1.0 及更舊版本中稱為 RESTful 存取命名空間應用程式發展介面，或 RAN API）
此區域允許對群集中的文件和目錄進行操作。


程序

在測試系統組態 API 或檔案系統存取 API 時，使用具有「root」登入資料的 curl 命令。

  1. 請在叢集的任何節點上建立 SSH 連線，然後使用「root」帳戶登入。
  2. 請使用 curl 命令，如下面的 系統組態 API 或 檔案系統存取 API 部分中所述。 
  3. 如果您持續遇到問題，請聯絡 Isilon 技術支援部門。

有關 curl 命令和語法的其他資訊，請參見 curl 手冊頁。

如需 OneFS 系統組態 API 要求和預期回應的其他資訊，請參閱個別 OneFS 版本的 API 參考指南。最常見 OneFS 版本的連結：OneFS 8.2.2.0、OneFS 9.1.0、 OneFS 9.5.0.0 和 OneFS 9.7.0.0

系統組態 API

使用系統組態 API 執行 curl 的常見選項 

選項 說明
-d  在 POST 要求中傳送指定的資料
-H 指定要使用的額外標頭
-k 允許連線至不受信任的 SSL 網站 （針對 Isilon 預設的自我簽署 SSL 憑證）
-u 用於身份驗證的使用者名稱 執行此命令時，系統會提示您提供此使用者的密碼
-v 指定詳細輸出
-X  指定要求方法 （GET、PUT、POST 等）

 

curl 與系統組態 API 的常見用法

以下是常見 curl 命令的範例。對要執行的操作遵循類似的語法。

  • 擷取資訊 （GET 命令）：

    一般語法：使用以下方法，其中 <username> 是使用者名， <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 命令）：

    一般語法：使用下列方法，其中 <username> 是使用者名稱，<json-data> 是 JSON 格式的字串，而< URL> 是您要連線的節點的 URL。 
    # curl  -vk  -u <username> -H 'Content-type:application/json' -X POST  -d '<json-data>' <URL>



    例如，若要建立名為 papi-example 且路徑為 /ifs/papi-example 的新 SMB 共用，命令看起來類似於以下內容： 
    # 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

使用檔案系統存取 API 執行 curl 的常見選項

選項 說明
-d  在 POST 要求中傳送指定的資料
--資料二進位 指定二進位檔案的位置
-H 指定要使用的額外標頭
-k 允許連線至不受信任的 SSL 網站 （Isilon 預設自我簽署 SSL 憑證）。
-u 用於身份驗證的使用者名，系統會提示您提供此用戶的密碼。
-v 指定詳細輸出 
-X  指定要求方法 （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 命令）：

    一般語法：使用正確的變數 <內容標頭>使用以下命令。如需<內容標頭>的相關資訊，請參閱 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.