Web サービス API リファレンス

内容
casp1032
DX NetOps Spectrum
Web サービス API について
DX NetOps Spectrum
Web サービス API は、
DX NetOps Spectrum
で RESTful HTTP Web サービス インターフェースを提供します。 この分散 API は、
DX NetOps Spectrum
データ モデルに HTTP ベースの統合ポイントを提供します。これにより、デバイス、モデル、関係、属性、アクション、およびアラームへの Web 中心の読み取り/書き込みアクセスが許可されます。
DX NetOps Spectrum
Web サービス API は、コア
DX NetOps Spectrum
コンポーネントであり、コア
DX NetOps Spectrum
製品と共にインストールされます。
DX NetOps Spectrum
Web サービス API を使用して、
DX NetOps Spectrum
データにブラウザから直接アクセスしたり、独自のアプリケーションに統合したりできます。 REST アーキテクチャ固有の基準により、
DX NetOps Spectrum
Web サービス API では、
DX NetOps Spectrum
データ モデルが多くの異なる外部開発環境および方式にアクセス可能です。
DX NetOps Spectrum
Web サービス API は、HTTP 統合の管理方法を認識し SOAP サービスに軽量な代替機能を提供する、任意の言語で使用できます。
DX NetOps Spectrum
Web サービス API を使用すると、OneClick サーバによって提供される機能(その検索インフラストラクチャを使用してモデルのグループを容易に検索するなど)を利用できます。 単一の
SpectroSERVER
用に、または分散
SpectroSERVER
(DSS)環境で、以下のようにさまざまな標準の
DX NetOps Spectrum
機能を実行することもできます。
  • デバイス、モデル、関係、属性、アクション、およびアラームへのアクセス
  • デバイス、ポート、コンテナ、サービス、およびリンクの管理
  • アラームの読み取り、更新、およびクリア
  • サブスクリプションおよび通知の管理
DX NetOps Spectrum
Web サービス API を使用して、これらの機能と、さらに他の
DX NetOps Spectrum
API ツール(コマンド ライン インターフェース(CLI)、モデリング ゲートウェイ、AlarmNotifier、Southbound ゲートウェイ、SpectroSERVER オブジェクト リクエスト ブローカ(SSORB)インターフェースなど)によって提供される機能に似ているその他の機能を実行できます。
REST アーキテクチャ
Representational State Transfer (REST)は、対話するエレメント間、またはクライアントとサーバ間の標準的な動作をプロモートするソフトウェア アーキテクチャ スタイルです。 REST の制約に準拠することを RESTful と言います。
REST アーキテクチャは、作成(POST)、読み取り(GET)、更新(PUT)、および削除(DELETE)操作、または動詞を使用した、SOAPless Web サービスに対する軽量の HTTP/HTTPS ベースのアプローチです。 
RESTful アーキテクチャおよびアプリケーションはステートレスです。つまり、リクエスト間にクライアント コンテキスト情報は格納されません。 各リクエストには、リクエストの処理に必要なすべての情報が含まれています。
DX NetOps Spectrum
Web サービス API は、REST アーキテクチャをサポートしています。
サポート対象の技術
DX NetOps Spectrum
Web サービス API は、アプリケーションに
DX NetOps Spectrum
データを統合するための軽量で柔軟な RESTful アプローチを提供します。 CORBA 統合に代わる
DX NetOps Spectrum
Web サービス API は、言語に依存せず、HTTP 統合をサポートする以下のようなすべての開発プラットフォームに統合できます。
  • Java
  • Perl
  • Ruby on Rails
  • .net
DX NetOps Spectrum
Web サービス API は、HTTP/HTTPS インターフェースを提供し、HTTP ベースでも XML/JSON ベースでもあり、クライアント開発用の Java Beans を備えています。
パフォーマンス考慮事項
DX NetOps Spectrum
Web サービス API は、OneClick によく似たクライアントです。
DX NetOps Spectrum
Web サービス API は、OneClick サーバ コードの多くを再利用しているため、通常は 1 つの API クライアントのパフォーマンスが同等の OneClick 操作のパフォーマンスによく似ています。
DX NetOps Spectrum
Web サービス API は、標準のリクエスト ロードによる場合を除き、
SpectroSERVER
パフォーマンスを変更できません。
以下の場合は、パフォーマンスの問題が発生する可能性があります。
  • OneClick サーバにデータがキャッシュされるため、複数のクライアント間での大規模なデータ リクエストはパフォーマンスの低下を引き起こす可能性があります。
  • DX NetOps Spectrum
    Web サービス API を介して低パフォーマンスの新しい検索を作成して実行した場合、パフォーマンスが低下することがあり、SpectroSERVER がクラッシュする可能性もあります。
    詳細については、「Web サービス API の問題のトラブルシューティング」を参照してください。
制限事項
DX NetOps Spectrum
Web サービス API を使用する場合は、以下のことを考慮する必要があります。
  • DX NetOps Spectrum
    Web サービス API は、データが通常は静的であるモデリング カタログに対してインターフェースを提供しません。
  • DX NetOps Spectrum
    Web サービス API の上に HTML またはブラウザ アプリケーションを構築することはできますが、
    DX NetOps Spectrum
    Web サービス API 自体は HTML を提供しません。
  • DX NetOps Spectrum
    Web サービス API は、入力に XML のみを受け入れ、出力に XML または JSON を生成します。 出力として JSON を選択した場合は、次の要求用に解析を行い、XML を生成する必要がある可能性があります。
DX NetOps Spectrum
Web サービス API は、簡単な CLI アド ホック コマンド用に使用したり、複雑な CLI スクリプト記述の代わりに使用したりできます。
DX NetOps Spectrum
Web サービス API は強力なツールです。 特にモデリングに関して、OneClick のような保護手段は提供されません。 これは、やみくもにモデルを作成および破壊したりモデル属性を変更するとネットワーク モデリング スキームに悪影響を及ぼす可能性があることを理解したうえで、
DX NetOps Spectrum
管理者のみが使用する必要があります。