Cisco UCS Director API 統合およびカスタマイゼーション ガイド、リリース 5.4
REST API
REST API

REST API

この章は、次の項で構成されています。

Cisco UCS Director REST API

Cisco UCS Director では REST API が提供され、アプリケーションは Cisco UCS Director に格納されているデータを消費または操作できます。Cisco UCS Director REST API(以後単に「REST API」とする)は軽量フレームワークで、アプリケーションが使用する際のオーバーヘッドはわずかで済みます。

アプリケーションは REST API からの HTTP および HTTPS 要求を使用して、Cisco UCS Director リソース上で作成/読み取り/更新/削除(CRUD)の操作を実行します。

いつ Cisco UCS Director REST API を使用するか

Cisco UCS Director REST API は、HTTP または HTTPS 要求を作成できるプログラムまたはスクリプトで使用できる言語非依存インターフェイスです。別のプログラムまたはプロセスから Cisco UCS Director 上の操作を呼び出すには、REST API を使用します。

アプリケーションは、REST API を使用して次のことを実行できます。

  • Cisco UCS ドメイン内の物理デバイスおよび仮想デバイス、ネットワーク、アプライアンス、グループおよびユーザ、ポリシー、リソース アカウンティング、資金、その他の監視対象エンティティに関する Cisco UCS Director レポートの取得。

  • Cisco UCS Director Orchestrator ワークフローおよびタスク操作の呼び出し。

  • Cisco UCS Director に固有の追加操作の呼び出し。

Cisco UCS Director REST API の使用

REST API クライアントは標準の HTTP または HTTPS の要求および応答を使用して Cisco UCS Director とやりとりするため、REST API 応答は Web ブラウザと互換性があります。多くのプログラミング言語には、HTTP 要求の作成と送信、および HTTP 応答の処理に専用のライブラリがあります。

REST API コールの大部分は、要求または応答内のデータをそれぞれ送信および返信します。これらのデータ ペイロードは、REST API コールに応じて 2 つの方法のいずれかでフォーマット化される場合があります。JavaScript Object Notation(JSON)ペイロードを使用する REST API コールもあれば、XML ペイロードを使用するものもあります。通常の場合、複雑と見なされるアプリケーションには両方を使用する必要があります。

JSON ベースの REST API コールは、JSON ペイロードを使用した単純な HTTP 要求および応答です。JSON は、判読可能なデータ交換のために設計された軽量テキスト ベースのオープン スタンダードです。JSON は、単純なデータ構造と連想配列を表します。アプリケーションは、特殊な REST API ライブラリを使用することなく JSON ベースの API を直接呼び出し、アプリケーションに固有の方法を使用して JSON データを解析します。

XML ベースの REST API コールは HTTP 要求および応答でもありますが、アプリケーションに Cisco UCS Director REST API ライブラリ jar が含まれており、アプリケーションが REST ペイロードの API 定義された JavaBeans(単純な古い Java オブジェクト「POJO」とも呼ばれる)を使用する必要があります。API jar を使用して、Java オブジェクトを行き来する XML メッセージのペイロードをそれぞれマーシャリングおよびマーシャリング解除することができます。

REST API の認証は、Cisco UCS Director の登録済みユーザのみが API 要求を作成できることを要求することによって実行されます。ユーザが Cisco UCS Director で作成および登録されると、そのユーザには一意の REST API アクセス キーが割り当てられます。このキーは、API コールの作成時に HTTP または HTTPS 要求ヘッダーに提示する必要があります。その後、ユーザには、Cisco UCS Director にある REST API を介した同じデータおよび操作へのアクセス権が付与されます。

システム要件と、開発環境をセットアップして、ライブラリをインストールし、REST API の使用を開始する方法については、『Cisco UCS Director REST API Getting Started Guide』を参照してください。

REST API の使用に関する注釈付きの例については、『Cisco UCS Director REST API Cookbook』を参照してください。

すべての Cisco UCS Director REST API 機能の完全なリストについては、『Cisco UCS Director REST API URI Reference』を参照してください。