Postman による Intersight API の利用方法

[Akiyoshi Kawaguchi]

本ドキュメントでは、Postman で Intersight API の利用方法を紹介させていただきます。

• 事前準備
• Postman のインストール
• Environments ファイルと Collections ファイルの取得
• Intersight API Key の取得
• Postman の設定
• Environments ファイルと Collections ファイルのインポート
• API Key の設定
• クエリの作成
• クエリの実行

事前準備

Postman のインストール

以下のサイトから Postman をダウンロードして、インストールします。

https://www.postman.com/

Environments ファイルと Collections ファイルの取得

以下のサイトから、Postman の Environments ファイルと Collections ファイルをダウンロードします。

https://github.com/movinalot/intersight-rest-api/blob/master/Intersight.postman_environment.json

https://github.com/movinalot/intersight-rest-api/blob/master/intersight.postman_collection.json

Intersight API Key の取得

Intersight UI から API Key を生成して、API Key ID と Secret Key をメモしておきます。
※ Secret Keyは後から再確認することはできません。
※ API Key の生成には、Intersight Essentials 以上のライセンスが必要です。

1. System > Settings > API Keys メニューで、Generate API Key をクリック。

2. API key for OpenAPI schema vesion 2 を選択して、Generate を実行します。
生成された API Key ID と Secret Key をメモしておきます。

Postman の設定

Environments ファイルと Collections ファイルのインポート

1. Postman を起動して、自分の Workspace へ移動します。

2. Import で Environments ファイルと Collections ファイルをインポートします。

3. Collections に Cisco Intersight が作成され、Environments に Intersight が作成されたことを確認します。

API Key の設定

Postman の Environments > Intersight メニューで、以下のキーの Current value に Intersight から取得しておいた API Key ID と Secret Key を設定します。設定が完了したら Save を実行します。

• api-key-id  :  API Key ID を入力
• secret-key  :  Secret Key を入力

クエリの作成

Collection "Cisco Intersight" にないクエリを実行したい場合は、Any Query を Duplicate して URL やパラメータを変更・追加します。
クエリについては、Cisco Intersight API Docs を参考にします。

以下は、自分のアカウントを取得する iam.Account クエリを作成する例になります。

1. Any Query を Duplicate して、名前を変更します。

2. 作成した Accounts の URL に iam.Account クエリの URL を入力して Save します。

クエリの実行

実行したいクエリを選択し、右上の Environment が Intersight になっていることを確認して、Send を実行します。
200 OK となれば、クエリは正常に処理され、Body で結果が確認できます。

以上です。

参考ドキュメント：
Introduction to the Cisco Intersight REST API with Postman