FSx for ONTAP REST API を使用するにはどうすればよいですか?

所要時間3分

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 インターフェイスを使用する

一部の NetApp ONTAP API には、BlueXP r Connector Swagger インターフェイスを使用してアクセスできます。詳細については、NetApp のウェブサイトの「Learn about BlueXP」(BlueXP の詳細) および「How to log in to BlueXP (formerly Cloud Manager) API Swagger interface」(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"
}

注: E メール ID は fsxadmin ではありません。E メールは、BlueXP Connector へのログインに使用される Cloud Central Auth0 の E メール 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] (レスポンス本文) からログインが成功したことを確認します。