Data Aggregator REST Web サービス

Data Aggregator REST Web サービスは、データの取得や、プロファイルとテナントまたはグループ間の関係の管理など、管理上の操作を管理します。 リクエストを送信してレスポンスを受信できる、REST クライアント ツールまたは HTTP ツールを使用します。 いくつかの REST Web サービスは、テナント ドメインに範囲を指定できません。
capm250
HID_REST_WebServices
Data Aggregator REST Web サービスは、データの取得や、プロファイルとテナントまたはグループ間の関係の管理など、管理上の操作を管理します。 リクエストを送信してレスポンスを受信できる、REST クライアント ツールまたは HTTP ツールを使用します。 いくつかの REST Web サービスは、テナント ドメインに範囲を指定できません。
これらの REST サービスには、以下の 2 つのタイプが含まれます。
  • データ駆動型
    監視プロファイルやグループなどの Data Aggregator 設定情報を、読み取りおよび変更します。
  • 一般
    メトリック ファミリおよび制限付きの SNMP ベンダー認定サポートを管理します。 汎用的な REST Web サービスは自己フィルタリングで、関係を管理するために URL 内の引数を使用しません。
基本的な Data Aggregator の REST 操作
各エンドポイントは、グループ、監視プロファイル、テナント、デバイス認証などの、アイテムのタイプにマップします。 結果のリストを返すか、またはアイテムを作成、更新、または削除するには、特定のエンドポイントを使用します。
個別のメトリック ファミリ アイテムおよび SNMP ベンダー認定アイテムは、ID ではなく名前を使用して指定されます。
Data Aggregator REST Web サービスを使用して操作を実行するときは、コンテキスト タイプ ファイルを
application/xml
に設定してください。
基本的な操作
  • GET http://.../
    endpoint
    指定されたタイプのアイテムすべてのリストを返します。 getlist.xsd スキーマで戻り値データの形式を定義します。
  • GET http://.../
    endpoint
    /[
    id
    |
    name
    ]
    指定された ID または認証名を持つ単一アイテムの詳細を返します。 XSD スキーマで戻り値データの形式を定義します。
  • POST http://.../
    endpoint
    指定された要素を持つ、指定されたタイプのオブジェクトを作成します。 XSD スキーマで戻り値データの形式を定義します。
    POST 操作では、名前が同じで ID が異なるオブジェクトを作成できます。 この規則が許可される理由は、オブジェクトが別のテナントを対象としているときは多くの場合、有効になるためです。
  • PUT http://.../
    endpoint
    /[
    id
    |
    name
    ]
    指定されたアイテムの属性を更新します。 update.xsd スキーマで形式と所定のフィールドを定義します。
    PUT 操作では、名前が同じで ID が異なるオブジェクトを作成できます。 この規則が許可される理由は、オブジェクトが別のテナントを対象としているときは多くの場合、有効になるためです。
  • DELETE http://.../
    endpoint
    /[
    id
    |
    name
    ]
    ID または認証名を使用して指定されるアイテムを削除します。
一般的な REST Web サービス
一般的な REST Web サービスを使用して、メトリック ファミリおよび制限付きの SNMP ベンダー認定サポートを管理します。 汎用的な REST Web サービスは自己フィルタリングで、関係を管理するために URL 内の引数を使用しません。
以下の URL は、システムでユーザが対面する一般的な Web サービスすべての詳細を表示します。
http://
DA_host
:8581/genericWS
この URL は、XSD、URI、サポートされた HTTP メソッド、属性および関係などの一般的な Web サービスについての詳細情報を含みます。
特定のエンドポイントに関する詳細なドキュメントを表示するには、次の URL にアクセスします:
http://
DA_host
:8581/genericWS/
endpoint
/documentation
一般的な REST Web サービスでの関係の管理
一般的な REST Web サービスは、関係を管理するために URL 内の引数を使用しません。 代わりに、一般的な REST Web サービスは、関係の管理を基本的な操作に頼っています。 エンドポイントは、情報を公開するために自身をフィルタにかけます。 これらの方法は、メトリック ファミリおよび SNMP ベンダー認定の間の関係を管理するために使用されます。
一般的な REST Web サービス用の関係は以下のメソッドを使用して表示、作成、削除されます。
  • GET
  • PUT
  • DELETE
すべてのメソッドは、以下の URL を使用します。
http://
DA_host
:8581/genericWS/
endpoint/name/endpoint
例: SNMP ベンダー認定に関連するメトリック ファミリのリスト
指定された SNMP ベンダー認定のメトリック ファミリのリストを返すには、以下の URL で GET 操作を使用します。
http://
DA_host
:8581/genericWS/certifications/snmp/
name
/metricfamilies
データ駆動型 REST Web サービス
管理者は、ほとんどの Data Aggregator Web サービス(プロファイルやグループの監視など)で、データ駆動型 REST Web サービスを使用します。
以下の URL は、システムでユーザが対面するデータ駆動型 Web サービスすべての詳細を表示します。
http://
DA_host
:8581/rest
この URL は、XSD、URI、サポートされた HTTP メソッド、属性、および関係などのエンドポイントおよびデータ駆動型 Web サービスについての詳細情報を含みます。
特定のエンドポイントに関する詳細なドキュメントを表示するには、以下の URL にアクセスします。
http://
DA_host
:8581/rest/
endpoint
/documentation
データ駆動型 REST Web サービス用の XSD スキーマの表示
HTTP リクエストを実行する前に以下の手順を行います。
  • エンドポイント用の XML スキーマ定義(XSD)を確認します。
  • 戻り値の形式を確認するか、またはサービスが提供する XML をアップロードします。
XML ドキュメント内に配置されるコンテンツのアイテムは、それぞれエンドポイントの説明に忠実である必要があります。
各操作の XSD ファイルには、属性およびメトリック ファミリの目的を説明するタグが含まれます。 エンドポイント用の XSD を取得するには、以下のパスのデータ駆動型 Web サービス URL を使用します。
http://
DA_host
:8581/rest/
endpoint
/XSD/
operation
.xsd
  • operation
    実行する操作のタイプを指定します。
    値:
    • get
      単一アイテム get 用の XSD
    • getlist
      エンドポイント アイテムのリスト用の XSD
    • filterselect
      GET トンネリングを使用して高度なフィルタ条件とリターン XML 形式を指定する XSD
    • 作成
      作成する際、すべての入力 XML が一致する必要がある XSD
    • 更新
      更新する際、すべての入力 XML が一致する必要がある XSD
    一部の操作は、各エンドポイントでサポートされません。 操作がサポートされていない場合、Web サービスは失敗し、「403 Forbidden」メッセージを返します。
データ駆動型 REST Web サービスの XSD スキーマ内の属性でフィルタ
アイテム名、説明、および他の属性でフィルタすることができます。 たとえば、監視プロファイルを、それらに含まれるメトリック ファミリでフィルタリングします。 この情報を使用して、メトリック ファミリを監視プロファイルに追加または削除するかどうかを決定できます。
以下の手順に従います。
  1. Web ブラウザに以下の URL を入力します。
    http://
    DA_host
    :8581/rest/
    リストに、利用可能なデータ駆動型 Web サービスが表示されます。
  2. Web サービスをクリックします。
    その Web サービス用のドキュメント ページが開きます。
  3. 「フィルタリングされた GETList」メソッド下の URL をクリックします。
    XSD スキーマが表示されます。
  4. 以下のプロパティを含むエレメントを探します。
    substitutionGroup="AttributeFilterTypeSubstitution
    この情報を使用してどの属性をフィルタリングするかを決定します。
  5. リクエストを送信してレスポンスを取得する REST クライアント エディタまたは HTTP ツールを開き、コンテンツ タイプを
    application/xml
    に設定します。
  6. 以下のフィルタ条件を入力します。
    • URL:
      http://
      DA_host
      :
      port
      /rest/
      endpoint
      /filtered/
    • HTTP method = POST
      このメソッドはフィルタ条件を定義する必要があります。
    • [HTTP 要求]ペイン内の[Body]タブ上の基本的なフィルタ選択条件は以下のとおりです。
      <FilterSelect xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="filter.xsd">
      <Filter>
      <
      elementName
      type="CONTAINS">
      filter-criteria
      </
      elementName
      >
      </Filter>
      </FilterSelect>
      • filter-criteria
        属性の実際の値を指定します。
      • elementName
        フィルタするエレメント名(属性)を指定します。
      ポーリング レートのみのように、選択条件も指定できます。 この方法は、Get トンネリングとも呼ばれます。 詳細については、以下の例を参照してください。
    結果は[HTTP Response]ペインの[Body]タブに返されます。
例: フィルタおよび選択条件を使用して、メトリック ファミリを含む監視プロファイルのリストを返します(Get トンネリング)。
選択条件としてポーリング レートを使用してメトリック ファミリを含む監視プロファイルを返すには、以下のメソッドを使用します。
  • メソッド:
    POST
  • URL
    :
    http://
    DA_host
    :8581/rest/monitoringprofiles/filtered/
  • Body:
    <FilterSelect xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="filter.xsd">
    <Filter>
    <MonitoringProfile.FacetTypes type="CONTAINS">{http://im.ca.com/normalizer}NormalizedPortInfo</MonitoringProfile.FacetTypes>
    </Filter>
    <Select use="exclude" isa="exclude">
    <MonitoringProfile use="exclude">
    <PollRate use="include"/>
    </MonitoringProfile>
    </Select>
    </FilterSelect>
例:
フィルタおよび選択条件を使用して
アイテムを含む監視プロファイルのリストを返します。
選択条件として名前を使用して、アイテムを含む監視プロファイルを返すには、以下のメソッドを使用します。
  • メソッド:
    POST
  • URL
    :
    http://
    DA_host
    :8581/rest/monitoringprofiles/filtered/
  • Body:
    <FilterSelect xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="filter.xsd">
    <Filter>
    <MonitoringProfile.FacetTypes type="CONTAINS">{http://im.ca.com/normalizer}NormalizedPortInfo</MonitoringProfile.FacetTypes>
    </Filter>
    <Select use="exclude" isa="exclude">
    <Item use="exclude">
    <Name use="include"/>
    </Item>
    </Select>
    </FilterSelect>
データ駆動型 REST Web サービスとの基本関係の管理
関係を作成または削除するには、以下の URL で PUT または DELETE 操作を使用します。
http://
DA_host
:8581/rest/
endpoint
/
id
/relatesto
/endpoint
/
id
ネストされた関係を表示するには、以下の URL を使用します。
http://
DA_host
:
8581
/rest/
endpoint
/
id
/relatesto/
endpoint
/
endpoint
特定の監視プロファイル ID 781 のすべての関連グループとデバイスを表示するには、以下の URL で、GET コールを使用します。
http://
DA_host
:8581/rest/monitoringprofile/781/relatesto/groups/devices
レスポンス URL は、指定された監視プロファイル ID の関連グループとデバイスすべてをリスト表示します。この監視プロファイル ID には、現在の getlist.xsd ファイルにある属性が備わっています。
データ駆動型範囲のテナント ドメインへの制限
Data Aggregator の一部の機能について、操作のデータ駆動範囲を特定のテナント ドメインに制限し、グローバル リポジトリ全体の情報にアクセスできないようにすることができます。
以下の基本的方法を使用して、特定のテナント ドメインを持つエンドポイントの情報にアクセスします。
GET http://
DA_host
:
port
/rest/tenant/
id
/
endpoint
テナント ドメインを持つ Web サービスのすべてではなく一部を使用できます。