Cisco UCS Director REST 開発者ガイド、リリース 4.1
概要
概要
発行日;2014/02/05   |   ドキュメントご利用ガイド   |   ダウンロード ;   この章 pdf   ,   ドキュメント全体 pdf    |   フィードバック

概要

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

Cisco UCS Director REST API の概要

Cisco UCS Director REST API は Cisco UCS Director リソースでの操作実行を可能にし、またこれらの操作をアプリケーションに統合してアプリケーションで API 対応の機能を提供できるようにします。

この REST(Representational State Transfer)API を使用して開発したプリケーションでは、以下が可能です。

  • Cisco UCS ドメイン 内の物理デバイスおよび仮想デバイス、ネットワーク、アプライアンス、グループおよびユーザ、ポリシー、管理、リソース アカウンティング、資金、その他監視対象に関する Cisco UCS Director レポートの取得。
  • オーケストレータ ワークフローおよびタスク操作の呼び出し。
  • Cisco UCS Director 独自の追加操作の呼び出し。

アクセス権限

適切なアクセス権限があれば、API を使用して Cisco UCS Director から利用可能なあらゆるレポートを取得できます。 API インターフェイスへのアクセスは登録済みユーザ アカウントに制限されています。 安全なアクセスは各ユーザ アカウントに割り当てられた一意のキー コードである「REST API アクセス キー」の使用によって管理されます。 ユーザ アカウントは管理上ユーザ タイプに関連付けられているため、このアクセス キーによって API を通じて公開される情報に対するユーザ アカウントのアクセス レベルが決まります。

ユーザ タイプの違いによってアクセスできるデータのカテゴリが異なります。 Cisco UCS Director の管理者が各ユーザ タイプに関連付けられるアクセス規則を定義します。 エンドユーザおよび管理者のユーザ タイプと各ユーザ タイプがアクセスできるデータの詳細については、『UCS Director Administration Guide』を参照するか、システム管理者にお問い合わせください。 システム管理者と相談し、プロジェクトに必要なユーザ アクセス権限を取得してください。

サポートされているプロトコルおよび形式

Cisco UCS Director REST API はあらゆる HTTP または HTTPS ブラウザと互換性があります。 REST API は JSON および XML でフォーマットされたコードを使用します。 Java API も利用できます。

JSON

別途記載がある場合を除き、Cisco UCS Director API ドキュメンテーションは JSON(JavaScript Object Notation)形式でエンコードされた REST API 要求の引数と応答(ペイロード データ)を参照します。 詳細については、 http:/​/​www.json.orgまたは http:/​/​en.wikipedia.org/​wiki/​JSONを参照してください。


(注)  


ライブの有効な JSON 形式の UCS Director REST API 要求および応答が Cisco UCS Director 内で提供されます。 それらは JSON プロトコルおよびフォーマットのよい例です。 この API データを確認するには、まず開発者メニューを有効にしてから、Cisco UCS Director の任意のレポートで利用できる [レポート メタデータ] オプションを使用します。 詳細については、開発者メニュー オプションの有効化を参照してください。


XML

XML 形式の REST API 要求の使用については、REST API ブラウザの使用を参照してください。 これは Cisco UCS Director に組み込まれている REST API ブラウザの使用に関する情報を提供します。

Java

Java API の使用については、Cisco UCS Director REST API Javadocs または Cisco UCS Director Open Automation API Javadocs を参照してください。

推奨ツール

Cisco UCS Director API は HTTP または HTTPS を通信プロトコルとして使用します。 ユーザ アカウント アクセス機能を利用できる任意の対応ブラウザまたはクライアントを使用して要求を Cisco UCS Director API に送信することができます。 ほとんどのプログラミング言語には、REST API アクセスと JSON および XML のパースを提供するビルトインまたはオープン ソースのライブラリがあります。

API の活用とテストには、次のソフトウェア ツールおよびオプションを推奨します。

開発者メニュー オプション

Cisco UCS Director には、レポート メタデータや Rest API ブラウザへのアクセスなど、開発者にとって重要な機能とツールを含む開発者メニュー オプションがあります。 これらのオプションを有効にする方法については、レポート メタデータへのアクセスを参照してください。

Mozilla Firefox RESTClient アドオン

RESTClient は Mozilla FireFox のアドオンで、API 要求と応答のパースや表示に役立つオプションを提供します。 https:/​/​addons.mozilla.org/​en-US/​firefox/​addon/​restclient/​?src=ssを参照してください。またより最近のリリースをご確認ください。


(注)  


アプリケーションが使用するユーザ アカウント クレデンシャルで現在 Cisco UCS Director にログインしている場合、任意の対応 Web ブラウザを使用して API 要求の送信と応答の取得ができるはずです。 しかし、Mozilla Firefox RESTClient アドオンは、便利かつ有益な方法で API データのパースとラベル付けも行うスタンドアロンのクライアントを提供します。


Cisco UCS Director REST API ブラウザ

REST API ブラウザは Cisco UCS Director の [オーケストレーション] 領域で利用できます。 このブラウザは API 情報および API コード生成機能を提供するもので、REST API や Java API の両方を含む利用可能なあらゆる API を見やすく表示し、作業を促進します。

開発者メニューを有効にすると、この機能にアクセスすることができ、XML 形式の REST API および Java API を含む Cisco UCS Director の公開 API に関する包括的な情報を取得できます。 詳細については、REST API ブラウザの使用を参照してください。