Cisco Catalyst Center自身のCPU/メモリデータを取得するAPIのご紹介

Cisco Catalyst Center(以下CatC)では、Assurance機能により、管理しているNWデバイスのステータスをGUIで確認することが出来ます。過去30日間を遡って、様々な統計情報をグラフなどで可視化して表示出来て、Report機能からデータを出力することも出来ます。

ただし、これらの対象は管理しているNWデバイスであり、CatC自身のデータは含まれておりません。そこで、CatC自身のCPUやメモリの使用率を確認するために利用出来るAPIをご紹介します。

API(System Performance APIとSystem Performance Historical API)

メニュー > Platform > Developer Toolkit > API

こちらにサポートするAPIの一覧が表示されます。

この中に、"System Performance API" と"System Performance Hystorical API" という項目があります。

  • System Performance API
    • 指定した期間の合計/平均/最大値を取得
  • System Performance Historical API
    • 指定した期間の値の経過を1時間/1分単位で取得

どちらもCPU使用率やメモリ使用率などのデータが過去24時間まで取得可能となっています。

上記画面のName列をクリックすることで、そのAPIの詳細(APIで指定するURLやParameterなど)が確認でき、Actions列から"Try"をクリックすることで、CatCのGUI上でこれらのAPIを試すことが出来ます。

今回は、APIのテストによく利用されるPostman を使って動作を確認しました。

  • Postman : v11.36.6
  • CatC : ver2.3.7.7

Postmanによるテスト

Authentication API

事前準備として、CatCへの認証を行いTokenを取得します。

New Requestから、Authenticationと入力し、POSTを選択、Authentication APIのURL(http://{{cluster_ip}}/api/system/v1/auth/token)を入力します。

Authorization タブにて Auth Type=Basic Auth を選択し、CatC GUI のユーザ名/パスワードを入力します。

Headers タブにて、Content-type として application/json を入力します。Scripts タブに以下のスクリプト(取得するトークンを変数として X-Auth-Token に保存する)を入力し、Saveします。

var jsonData = JSON.parse(responseBody);
var auth_token = jsonData.Token;
pm.environment.set("X-Auth-Token", auth_token);

Sendボタンをクリックし、Tokenを取得します。上記スクリプトによりX-Auth-Tokenに保存され、再利用が可能です。

 

System Performance API

まず、CatCのGUIで詳細を確認します。下記のURLやRequest Query Parametersを利用します。

下記の通り入力し、Requestを作成します。

Parameter無しの場合

現時点~過去15分前の期間の各データの平均を取得します。


Parameterありの場合

例として、2025/3/18 10:00-11:00のCPUとメモリの最大値を取得します。

※ max/average/sumは1つのみ指定可、60秒より短い期間は指定不可

System Performance Historical API

まず、CatCのGUIで詳細を確認します。下記のURLやRequest Query Parametersを利用します。

下記の通り、Requestを作成します。

Parameter無しの場合

現時点~過去15分前の期間の各データの推移を1分毎に取得(最下部に平均も表示)します。

Parameterありの場合(59分以下)

例として、2025/3/18 01:05-01:45のCPUとメモリの推移を取得します。

※ 60秒より短い期間は指定不可。

Parameterありの場合(60分以上)

例として、2025/3/18 01:05-02:05のCPUとメモリの推移を取得します。

おわりに

Cisco Catatlyst Center自身のCPUとメモリを取得できるAPIについてご紹介しました。

CatC自身の監視をしたいという要件がありましたら、本記事を参考にしていただければ幸いです。

執筆担当者プロフィール
K.Ikeda

K.Ikeda(日本ビジネスシステムズ株式会社)

クラウドソリューション事業本部に所属。現在、Catalyst Centerの設計/構築などを中心とした案件に携わっています。趣味はキャンプとサッカー観戦。

担当記事一覧