如何使用 FSx for ONTAP REST API？

2 分钟阅读

我想使用 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 名称。在以下示例命令中，将 Password 和 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 Connector Swagger 界面访问某些 NetApp ONTAP API。更多相关信息，请参阅 NetApp 网站上的详细了解 BlueXP 以及如何登录 BlueXP（原 Cloud Manager）API Swagger 界面。

以下步骤是使用 BlueXP 访问 Swagger 界面并发布凭证的示例。

1. 在 BlueXP 连接器中，选择以问号表示的 Help（帮助）菜单，然后选择 API。

或者，直接进入 Swagger 界面（示例 URL：http://connectorip/occm/api-doc/）。

2. 选择用户管理操作。

3. 选择身份验证：身份验证操作。

4. 选择 POST /auth/login、扩展操作。

5. 选择模型架构。

6. 在显示以下内容的模型架构下选择单击以设置为参数值：

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

7. 在填充模型架构的值字段中，编辑字符串以提供正确的电子邮件和密码：

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

注意：电子邮件 id 不是fsxadmin。该电子邮件是用于登录 BlueXP 连接器的 Cloud Central Auth0 电子邮件 id。以纯文本形式设置密码。

8. 选择立即试用！

9. 通过响应代码验证是否登录成功。

示例：使用 BlueXP Swagger 界面获取卷 API

1. 在 Swagger 界面中，选择 FSx（Data ONTAP 集群）工作环境操作。

2. 选择 fsx/volumes。

3. 选择 GET /fsx/volumes、扩展操作。

4. 在值字段中，输入要从中检索卷列表的文件系统 ID。

5. 选择立即试用！

6. 通过响应代码和响应正文验证是否登录成功。