高度な OpenAPI クエリの例

OpenAPI の柔軟性をさらに活用するには、高度な OpenAPI クエリを使用します。 高度な OpenAPI クエリを使用して、独自の OpenAPI アプリケーションを構築できます。
capm350
OpenAPI の柔軟性をさらに活用するには、高度な OpenAPI クエリを使用します。 高度な OpenAPI クエリを使用して、独自の OpenAPI アプリケーションを構築できます。
OpenAPI サービスは、以下の詳細を表示できるように、メタデータ ドキュメントでその構造を宣言します。
  • 実行可能なリクエスト
  • 結果の構造
  • サービスを移動する方法
以下の URI を使用して、メタデータ ドキュメントを呼び出すことができます。
http://
da_host
:8581/odata/api/$metadata
特殊な集計関数
特殊な集計関数を使用して、以下の操作を実行できます。
  • 予測値の計算
  • しきい値に至るまでの予測時間の判断
  • これらの計算に使用されるスロープやインターセプトなどの線形データ モデルのプロパティを取得します。
これらの計算には、以下の特殊な集計関数を使用できます。
  • intercept
    予測ラインが Y 軸と交わる位置
  • 傾き
    予測ラインの傾き
  • 予測
    メトリックの将来のパフォーマンスを予測するライン
  • datasetcount
    線形データ モデルの計算に使用されるデータ ポイントの数
  • timetothreshold
    予測ラインがしきい値を超えるまでに必要な秒数
    この値は、
    starttime
    および
    endtime
    パラメータによって定義された時間間隔の終了時刻から計算されます。
    注:
    starttime
    および
    endtime
    が指定されていない場合は、デフォルトの時間間隔が使用されます。
しきい値予測パラメータ
予測およびしきい値予測を抽出するには、高度な OpenAPI クエリに以下のパラメータを含めます。
  • prjoffset
    予測を計算するための時間数(秒単位)
  • Threshold
    クエリのしきい値
予測およびしきい値予測の抽出
予測は、将来のパフォーマンスを予測します。 しきい値予測は、メトリックがしきい値を超えると予測されるタイミングを示します。 この機能を使用して、インフラストラクチャのキャパシティを管理し、必要に応じてハードウェアを再プロビジョニングまたは取得します。
以下の例では、予測およびしきい値予測を抽出する方法を示します。
1 つのメトリックの予測の表示
2016 年 8 月 10 日(水) 14:05:00 GMT から 24 時間以内の予測される CPU 使用率を表示します。
このデータを取得するには、以下の OpenAPI URL を使用します。
http://
da_host
:8581
/odata/api/cpumfs?apply=groupby(ID,aggregate(im_Utilization with projection as Value))&$select=ID,Value&starttime=1470837900&endtime=1470927900&resolution=DAY&prjoffset=86400
1 つのメトリックしきい値予測の表示
CPU 使用率が 40% を超えると予測されるタイミングを表示します。 データの計算に対するデフォルトの間隔は、ポーリングです。 しきい値予測が秒単位で返されます。
このデータを取得するには、以下の OpenAPI URL を使用します。
http://
da_host
:8581
/odata/api/cpumfs?$apply=groupby(ID,aggregate(im_Utilization with timetothreshold
as Value))&$select=ID,Value&threshold=40
指定した間隔のしきい値予測の表示
CPU 使用率が 40% を超えると予測されるタイミングを表示します。 データの計算に使用する間隔は、日単位です。 しきい値予測が秒単位で返されます。
このデータを取得するには、以下の OpenAPI URL を使用します。
http://
da_host
:8581
/odata/api/cpumfs?$apply=groupby(ID,aggregate(im_Utilization with timetothreshold
as Value))&$select=ID,Value&resolution=DAY&threshold=40
1 つのクエリからの複数の予測の表示
60 日間の発信と着信の両方のトラフィックに対する予測されるスルーアウト(ビット/秒)および破棄レートを表示します。 過去 3 か月間の時間単位のデータを使用します。
このデータを取得するには、以下の OpenAPI URL を使用します。
http://
da_host
:8581/odata/api/portmfs?apply=groupby
(ID,aggregate((im_BitsPerSecondIn with projection as im_BitsPerSecondIn),(im_BitsPerSecondOut with projection as im_BitsPerSecondOut),(im_DiscardsIn with projection as im_DiscardsIn),(im_DiscardsOut with projection as im_DiscardsOut)))&$select=ID,Value&starttime=1463320821&endtime=1471269621&resolution=HOUR&prjoffset=5184000
営業時間パラメータ
営業時間の時間範囲に基づいてデータを抽出するには、高度な OpenAPI クエリに以下のパラメータを含めます。
  • duration
    時間単位(
    s
    秒、
    h
    時間、
    d
    日、
    w
    週)でのマシンに基づいた時間間隔
    マシンに基づいた時間は、秒単位で時間の数または量をモデル化します。 マシンに基づいた時間は、時間、日、週など、他の期間に基づいた単位を使用してアクセスできます。 さらに、日単位は 24 時間に厳密に等しいとして処理され、これにより、夏時間効果が無視されます。 夏時間効果を無視するには、このパラメータを使用します。
    starttime
    および
    endtime
    パラメータと共に使用して、期間の開始ポイントまたは終了ポイントを指定できます。
    例:
    duration=1w
  • Period
    時間単位(
    s
    秒、
    h
    時間、
    d
    日、
    w
    週、
    m
    月、
    y
    年)での人間に基づいた時間間隔
    人間に基づいた時間は、年、月、および日単位で時間の数または量をモデル化します。 人間に基づいた時間には、夏時間およびその他の効果が含まれています。 夏時間効果を考慮する場合は、このパラメータを使用します。
    starttime
    および
    endtime
    パラメータと共に使用して、期間の開始ポイントまたは終了ポイントを指定できます。
    例:
    period=1w
  • tz
    クエリおよび任意の指定された営業時間の開始時間および終了時間に適用される、グリニッジ標準時(GMT)からのタイム ゾーン オフセット。
    tz
    パラメータを使用しない場合は、サーバのデフォルトのタイム ゾーンが使用されます。
    例:
    period=20d&tz=-4:00
    クエリで日単位または週単位の間隔を使用する場合、
    tz
    パラメータは無視されます。
  • bh
    業務時間
    例:
    bh=Mon-Fri
    bh=Mon,Tue,Fri
    bh=Mon 8:30am-5:30pm
    bh=Mon 8:30-17:30
    bh=Mon 8:30-12:30 13:30-17:30
以下の例に示すように、営業時間パラメータと共に
starttime
および
endtime
パラメータを使用できます。
  • starttime=1493145475&endtime=1493145775&bh=Mon-Fri 8:30am-5:30pm
  • starttime=2017-03-15T18:00:00&period=20d&bh=Mon-Fri 8:30am-5:30pm&tz=-8:00
  • endtime=2017-04-15T18:00:00&period=20d&bh=Mon-Fri 8:30am-5:30pm&tz=-8:00
  • startime=2017-03-15T18:00:00&period=20d&bh=Mon-Fri 8:30am-5:30pm&tz=-8:00
  • starttime=2017-03-15T18:00:00&endtime=2017:04:15T18:00:00&bh=Mon-Fri 8:30am-5:30pm
カスタム関数
以下のカスタム関数を使用できます。
  • getSchemaVersion
    スキーマのバージョン情報を参照します。
    例:
    http://
    da_host
    :8581/odata/api/getSchemaVersion
  • getDataCollectors
    Data Collector およびホスト名、IP アドレス、およびステータスを含むそれらの詳細のリストを参照します。
    例:
    http://
    da_host
    :8581/odata/api/getDataCollectors
  • getGroupMetricFamilies
    グループ別のメトリック ファミリのリストを参照します。
    例:
    http://
    da_host
    :8581/odata/api/getGroupMetricFamilies?&ID=
    GroupID
    $format=json&timeout=30
    • GroupID
      Data Aggregator からのグループ ID を指定します。
  • getDataAggregators-
    Data Aggregator とホスト名、IP アドレス、およびステータスを含むそれらの詳細のリストを参照します。
    例:
    http://
    da_host
    :8581/odata/api/getDataAggregators
  • getResultLimiters
    結果のリミッタのリストを参照します。
    例:
    http://
    da_host
    :8581/odata/api/getResultLimiters