Tuning Manager APIリファレンスガイド

[目次][索引][前へ][次へ]

2.1 Tuning Manager APIの共通仕様

Tuning Manager APIの共通仕様について説明します。

APIで扱いたいリソースを指定するには，URIを使用します。次に示すURIの形式の<schema>から<version>までが基底URIとなり，<domain>以下が，相対URIとなります。リソースは<domain>以下の相対URIに指定します。

URIの形式と，構成要素を示します。

形式

アラート機能で稼働監視する場合
<scheme>://<host>:<port>/<application>/<version>/<domain>/<object-type>[/<AlertDefId>][?<query-string>]
または
<scheme>://<host>:<port>/<application>/<version>/<domain>/<object-type>[/actions[/<action-identifier>/invoke]]

パフォーマンスデータを取得する場合
<scheme>://<host>:<port>/<application>/<version>[/<domain>[/<object-type>]][?<query-string>]
または
<scheme>://<host>:<port>/<application>/<version>/<domain>/<object-type>[/actions[/<action-identifier>[/invoke]]]

構成要素

表2-1 URIの構成要素

項目 説明
<scheme> プロトコル。
HTTP「http」とHTTPS「https」をサポートしています。
<host>

アラート機能で稼働監視する場合
APIクライアントがアクセスするDevice Managerのホスト名，またはIPアドレス

パフォーマンスデータを取得する場合
APIクライアントがアクセスするTuning Manager serverのホスト名，またはIPアドレス
<port>

アラート機能で稼働監視する場合
APIクライアントがアクセスするDevice Managerのポート番号
デフォルトはHTTPの場合は22015，HTTPSの場合は22016です。

パフォーマンスデータを取得する場合
APIクライアントがアクセスするTuning Manager serverのポート番号
デフォルトはHTTPの場合は22015，HTTPSの場合は22016です。
<application> アプリケーション名。
動作させるAPIの種類によって，指定するアプリケーション名が異なります。指定するアプリケーション名を次に示します。
  • アラート機能で稼働監視する場合：DeviceManagerWebService/analytics
  • パフォーマンスデータを取得する場合：TuningManager
<version> Tuning Manager APIのバージョン。
APIサービスの基底URIとなります。
「v<x>」（<x>はAPIバージョンのメジャーバージョン）の形式です。APIバージョンが1.<y>（<y>はAPIバージョンのマイナーバージョン。例えば，1.0，1.1，1.2など）の場合は<version>は「v1」となり，APIバージョンが2.<y>（例えば，2.0，2.1，2.2など）の場合は「v2」となります。
Tuning ManagerシリーズのバージョンとAPIのバージョンの対応については，「2.6 Tuning Manager APIのバージョン」を参照してください。
<domain> リソースのカテゴリ。※
次の4種類のドメインを提供します。
  • configuration
    APIの詳細情報
  • services
    HTM - Agentsのインスタンスに依存しないサービス情報
  • objects
    HTM - Agentsのアラート定義情報の設定に関する情報，およびインスタンス情報や監視対象から収集したパフォーマンスデータ
  • domain-types
    APIで使用するリソースのメタデータ
<object-type> リソース，サービスの種類。※
例：Objects URIのalert-defsやRAID_PD（"<Agent種別_レコード名>"の形式），Service URLのAgentManager
<AlertDefId> アラート定義名。※
<action-identifier> 任意のアクションを表す識別子。※
例：Service URIのrefresh
<query-string> クエリ文字列。

アラート機能で稼働監視する場合
参照したいアラート定義をAlertDefNameまたはTargetで指定します。

パフォーマンスデータを取得する場合
<object-type>を絞り込む条件などを指定します。リソースごとに指定可能なクエリ文字列は異なります。クエリ文字列がアルファベットを含む場合，インスタンス名，性能情報の時間粒度および取得方法を除き，大文字小文字は区別されます。また，クエリ文字列同士の順序は問いません。
なお，各リソースで定義されていないクエリ文字列を指定した場合は以下の状態になります。
  • リソースがパフォーマンスデータの場合はリクエスト不正となります。
  • リソースがパフォーマンスデータ以外の場合は無視されます。
クエリ文字列の指定方法については，各APIの説明を参照してください。

注※
指定できるリソースの詳細については，「3.1 Tuning Manager APIのリソース一覧」の「表3-1 アラート機能のアラート定義情報を設定および運用するAPI」，「4.1 Tuning Manager APIのリソース一覧」の「表4-1 Tuning Manager APIのリソース一覧」，および「5.1 Tuning Manager APIのリソース一覧」の「表5-1 Tuning Manager APIのリソース一覧」のURIを参照してください。

URIの指定例（RAID_PI_LDSレコードのパフォーマンスデータを指定する場合）

なお，見やすくするために改行を入れていますが，実際指定する際には改行を入れてはいけません。

https://127.0.0.1:22016/TuningManager/v1/objects/RAID_PI_LDS?
hostName=HOST
&agentInstanceName=AgentInstance
&startTime=2013-12-01T13:00Z
&endTime=2013-12-01T15:00Z
&fields=RECORD_TIME%1FLDEV_NUMBER%1FRANDOM_TOTAL_IO_RATE
&LDEV_NUMBER=00:00:01
&LDEV_NUMBER=00:00:02

<domain>以下に指定できるリソースについては，「3.1 Tuning Manager APIのリソース一覧」の「表3-1 アラート機能のアラート定義情報を設定および運用するAPI」，「4.1 Tuning Manager APIのリソース一覧」の「表4-1 Tuning Manager APIのリソース一覧」，および「5.1 Tuning Manager APIのリソース一覧」の「表5-1 Tuning Manager APIのリソース一覧」を参照してください。

[目次] [前へ] [次へ]

[マニュアル発行元]

All Rights Reserved. Copyright© 2014, 2020, Hitachi, Ltd.