如何將 FSx 用於 ONTAP REST API?

上次更新日期:2022 年 11 月 14 日

我想要使用 NetApp ONTAP REST API 來管理我的 Amazon FSx for NetApp ONTAP 資源。要怎麼做?

解決方案

先決條件

API 請求者必須能夠建立與 FSx for ONTAP 檔案系統以及儲存虛擬機器 (SVM) 端點的 HTTPS 連線。如需詳細資訊,請參閱使用 NetApp ONTAP REST API

使用 curl 在 FSx for ONTAP 檔案系統上執行 Hello World

在執行 FSx for ONTAP 檔案系統的 Amazon Virtual Private Cloud (Amazon VPC) 上 Linux 執行個體的命令列界面中,執行下列操作:

1.    輸入您的 fsxadmin 密碼和端點 DNS 名稱。在下列範例命令中,將密碼fs-XXXXXXXX.fsx.region.amazonaws.com 取代為您的使用案例的正確值:

$ CRED=fsxadmin:Password
$ ONTAP=management.fs-XXXXXXXX.fsx.region.amazonaws.com

2.    執行下列命令以擷取 ONTAP 軟體版本:

$ curl -X GET -u ${CRED} -k "https://${ONTAP}/api/cluster?fields=version"
{
  "version": {
    "full": "NetApp Release 9.10.1RC1P1: Sat Nov 27 18:08:32 UTC 2021",
    "generation": 9,
    "major": 10,
    "minor": 1
  },
  "_links": {
    "self": {
      "href": "/api/cluster"
    }
  }
}

範例 REST API:取得磁碟區

以下是用來擷取磁碟區的 GET 命令範例:

$ curl -X GET -u ${CRED} -k "https://${ONTAP}/api/storage/volumes"
{
  "records": [
    {
      "uuid": "504c8162-a435-11ec-bb13-130f21c56a08",
      "name": "svm1_root",
      "_links": {
        "self": {
          "href": "/api/storage/volumes/504c8162-a435-11ec-bb13-130f21c56a08"
        }
      }
    },
    {
      "uuid": "956f5ce9-a435-11ec-bb13-130f21c56a08",
      "name": "vol1",
      "_links": {
        "self": {
          "href": "/api/storage/volumes/956f5ce9-a435-11ec-bb13-130f21c56a08"
        }
      }
    }
  ],
  "num_records": 2,
  "_links": {
    "self": {
      "href": "/api/storage/volumes"
    }
  }
}

注意:某些 API 不會在 FSx for ONTAP 上執行。

使用 NetApp BlueXP API Swagger 界面

您可以使用 BlueXP r Connector Swagger 界面存取一些 NetApp ONTAP API。如需詳細資訊,請參閱 NetApp 網站上的進一步了解 BlueXP如何登入 BlueXP (先前稱為 Cloud Manager) API Swagger 界面

以下步驟是使用 BlueXP 和發佈憑證存取 Swagger 界面的範例。

1.    在 BlueXP Connector 中,選取以問號表示的 Help (說明) 功能表,然後選取 API

或者,直接前往 Swagger 界面 (範例 URL:http://connectorip/occm/api-doc/)。

2.    選取 User Management Operations (使用者管理操作)。

3.    選取 auth : Authentication operations (驗證:驗證操作)。

4.    選取 POST /auth/login (POST /驗證/登入)、Expand Operations (擴充操作)。

5.    選取 Model Schema (模型結構描述)。

6.    選取顯示下列項目的模型結構描述下的 Click to set as parameter value (按一下以設定為參數值):

{
"email": "string",
"password": "string"
}

7.    在填入模型結構描述的 Value (值) 欄位中,編輯字串以提供正確的電子郵件和密碼:

{
"email": "user@example.com",
"password": "xxxxxxxxxx"
}

注意:電子郵件 ID 不是 fsxadmin。電子郵件是用來登入 BlueXP Connector 的 Cloud Central Auth0 電子郵件 ID。密碼以純文字設定。

8.    選取 Try it out! (試用!)

9.    從 Response Code (回應代碼) 驗證是否成功登入。

範例:使用 BlueXP Swagger 界面取得磁碟區 API

1.    在 Swagger 界面中,選取 FSx (Data ONTAP cluster) working environment operations (FSx (Data ONTAP 叢集) 工作環境操作)。

2.    選取 fsx/volumes (fsx/磁碟區)。

3.    選取 GET /fsx/volumes (GET /fsx/磁碟區)、Expand Operations (擴充操作)。

4.    在 Value (值) 欄位中,輸入您想要從其中擷取磁碟區清單的檔案系統 ID。

5.    選取 Try it out! (試用!)

6.    從 Response Code (回應代碼) 和 Response Body (回應正文) 驗證是否成功登入。


此文章是否有幫助?


您是否需要帳單或技術支援?