サポートセンターホーム


レポートリソースについて

LogicMonitorのRESTAPIを使用して、アカウントのレポートをプログラムで管理できます。

次の種類のレポートは現在リリースされていませんが、次のリリースまたはXNUMXつでリリースされる予定であることに注意してください。

  • 監査ログレポート
  • アラート予測レポート

リソースURI:

/ report / reports

リソースのプロパティ:

すべてのレポートには、次のプロパティがあります。

プロパティ

製品説明

種類

id レポートのID 整数 「id」:80
レポートの名前 文字列 「名前」:「コレクタータスクの傾向」
説明 レポートの説明 文字列 「説明」:「私のレポートの説明」
type アラート| アラートSLA | アラートの傾向| アラートしきい値| ホストインベントリ| ホストメトリックの傾向| ホストCPU | インターフェイスの帯域幅| ウェブサイトサービスの概要| サービスレベルアグリーメント| Netflowデバイスメトリック 文字列 「タイプ」:「ホストメトリックの傾向」
グループID レポートが含まれるグループのID。Id= 0はルートレポートグループです。 整数 「groupId」:0
フォーマット HTML | PDF | CSV。 レポートの形式 文字列 「フォーマット」:「HTML」
配達 なし| Eメール。 レポートが電子メールで配信されるように構成されているかどうか 文字列 「配達」:「メール」
受信者 レポートが電子メールで配信されるように構成されている場合、このオブジェクトは、レポートの配信先となる受信者を提供します。 各レシピイントには以下を含める必要があります。

  • type:オプションは管理者です| 任意。ここで、adminはアカウント内のユーザーを指し、任意はユーザーアカウントに関連付けられていない電子メールアドレスを指します。
  • 方法:これは常にメールである必要があります
  • addr:type = adminの場合はユーザー名、type = arbitraryの場合はメールアドレスにする必要があります
  • コメント:レポートとともに配信する必要のあるコメント
JSONオブジェクト 「recipients」:[{「type」:「admin」、「method」:「email」、「addr」:「sarah」、「comment」:「」}、{「type」:「admin」、「method」 :” email”、” addr”:” Bill”、” comment”:””}、{“ type”:”任意の”、” method”:” email”、” addr”:”[メール保護]"、"コメント":""}]
スケジュール レポートが電子メールで配信される時期を示すcronスケジュール。 文字列 「スケジュール」:” 45 9 * * *”
lastmodifyUserId レポートを最後に変更したユーザーのID 整数 「lastmodifyUserId」:67
lastmodifyUserName レポートを最後に変更したユーザーのユーザー名 文字列 「lastmodifyUserName」:」[メール保護] 
enableViewAsOtherUser 他のユーザーがレポートを最後に変更したユーザーとしてレポートを表示できるかどうか。 ブーリアン 「enableViewAsOtherUser」:true
userPermission API呼び出しを行ったユーザーに関連付けられた権限 文字列 「userPermission」:「write」
lastGenerateOn レポートが最後に生成されたエポック形式の時刻 整数 「lastGenerateOn」:1449024667
lastGenerateSize レポートのサイズ(バイト単位)、最後に生成されたとき 整数 「lastGenerateSize」:21891
lastGeneratePages レポートのページ数、最後に生成された時間 整数 「lastGeneratePages」:4
customReportTypeId レポートがカスタムレポートの場合は、カスタムレポートテンプレートのID。 ID 0は、レポートがカスタムレポートではないことを示します。 整数 「customReportTypeId」:0
reportLinkNum レポートに関連付けられているリンクの数。各リンクは生成されたレポートに対応します。 整数 「reportLinkNum」:3

アラートレポートのプロパティ

次のプロパティは、アラートレポートに固有です。

プロパティ

製品説明

種類

日付範囲 レポート用に構成された時間範囲。 オプションは次のとおりです。過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm 文字列 「dateRange」:「過去24時間」
groupFullPath レポートに表示されるアラートを決定するために使用されるグループフィルター。 グロブ式がサポートされています。 文字列 「groupFullPath」:「*」
deviceDisplayName レポートに表示されるアラートを決定するために使用されるデバイスフィルター。 グロブ式がサポートされています。 文字列 “ deviceDisplayName”:” *”
dataSourceInstanceName レポートに表示されるアラートを決定するために使用されるインスタンスフィルター。 グロブ式がサポートされています。 文字列 “ dataSourceInstanceName”:” *”
データポイント レポートに表示されるアラートを決定するために使用されるグループフィルター。 グロブ式がサポートされています。 文字列 「dataPoint」:「*」
レベル すべて| エラー| クリティカル

  • :すべての重大度レベルのアラートは、フィルター基準に一致する場合に表示されます
  • エラー:フィルター基準に一致するエラーアラートとクリティカルアラートのみが表示されます
  • 重大な:フィルター基準に一致する重要なアラートのみが表示されます
文字列 「レベル」:「すべて」
sortBy カウント| ホスト| dataPoint | レベル| startOn | ackedOn。 表示されたアラートがレポートでどのようにソートされるか。 summaryOnlyがtrueに設定されている場合、sortedBy = count |に制限されることに注意してください。 ホスト| dataPoint。 summaryOnlyがfalseに設定されている場合、sortedBy = countを設定することはできません。 文字列 「sortedBy」:「count」
既存を含む
  • true:指定されたdateRangeより前に開始されたが、他のすべての基準を満たすアラートがレポートに表示されます
  • false:指定されたdateRangeの間に開始されたアラートのみがレポートに表示されます
ブーリアン 「includePreexist」:false
activeOnly
  • true:まだアラートを出している(つまり、まだクリアされていない)アラートのみがレポートに表示されます
  • false:アクティブなアラートとクリアされたアラートの両方がレポートに表示されます
ブーリアン 「activeOnly」:false
要約のみ
  • true:各アラートが発生した回数の詳細を示す列がレポートに追加されます
  • false:各アラートが発生した回数はレポートに表示されません
ブーリアン 「summaryOnly」:true
ackFilter すべて| 確認済み| 確認されていない

  • :レポート基準を満たす確認済みアラートと未確認アラートの両方が表示されます
  • 確認した:レポートの基準を満たす確認済みのアラートのみが表示されます
  • 確認されていない:レポートの基準を満たす未確認のアラートのみが表示されます
文字列 「ackFilter」:「all」
sdtFilter すべて| sdt | nonsdt

  • :レポートの基準を満たすSDTに含まれているアラートとSDTに含まれていないアラートが表示されます
  • SDT:SDTにあり、レポート基準を満たすアラートのみが表示されます
  • 非sdt:SDTになく、レポート基準を満たすアラートのみが表示されます
文字列 「sdt​​Filter」:「すべて」
タイミング オーバーラップ| start – time = overlapの場合、指定されたdateRangeの間にアクティブなアラートがレポートに表示されます。 time = startの場合、指定されたdateRangeの間に開始されたアラートのみがレポートに表示されます。 文字列 「タイミング」:「オーバーラップ」
情報源 レポートに表示されるすべてのアラートは、このフィルターで指定されたデータソースに対してトリガーされている必要があります。 文字列 "情報元":"*"
ルール レポートに表示されるすべてのアラートは、このフィルターで指定されたルールにルーティングされている必要があります。 文字列 "ルール":"*"
チェーン レポートに表示されるすべてのアラートは、このフィルターで指定されたエスカレーションチェーンにルーティングされている必要があります。 文字列 "鎖":"*"
コラム レポートに表示される列。 表示する順序で列を指定する必要があります。 このオブジェクトにはすべての列名を含める必要がありますが、各列には、表示されるかどうかを示すisHiddenフィールドが関連付けられている必要があります。 summaryOnlyがtrueに設定されている場合は、アラート、グループ、デバイス、インスタンス、データポイントの列のみを含めることができることに注意してください。 summaryOnlyがfalseに設定されている場合、次の列を含めることができます:重大度、グループ、デバイス、インスタンス、データポイント、しきい値、値、開始、終了、ルール、チェーン、取得済み、取得済み、取得済み、メモ、SDT内。 JSONオブジェクト “ columns”:[{“ name”:” Severity”、” isHidden”:false}、{“ name”:” Group”、” isHidden”:false}、{“ name”:” Device”、” isHidden”: false}、{“ name”:” Instance”、” isHidden”:false}、{“ name”:” Datapoint”、” isHidden”:false}、{“ name”:” Thresholds”、” isHidden”:false} 、{“ name”:” Value”、” isHidden”:false}、{“ name”:” Begin”、” isHidden”:false}、{“ name”:” End”、” isHidden”:false}、{ “ name”:” Rule”、” isHidden”:false}、{“ name”:” Chain”、” isHidden”:false}、{“ name”:” Acked”、” isHidden”:false}、{“ name ”:” Acked By”、” isHidden”:false}、{“ name”:” Acked On”、” isHidden”:false}、{“ name”:” Notes”、” isHidden”:false}、{“ name ”:” in SDT”、” isHidden”:false}]

アラートSLAレポートのプロパティ

次のプロパティは、アラートSLAレポートに固有です。

プロパティ

製品説明

種類

日付範囲 レポート用に構成された時間範囲:過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm 文字列 「dateRange」:「過去14日間」
hostsVal レポート用に選択されたデバイスORグループ(フルパスを使用)。複数のエンティティはコンマで区切られます。 globがサポートされていることに注意してください。 文字列 「hostsVal」:「Production / Server、AWS」
hostsValType ホスト| グループ。 hostsValフィールドで指定されたエンティティのタイプ。 文字列 「hostsValType」:「host」
情報源 レポート用に選択されたデータソースインスタンス(DatasourceName-InstanceNameの形式)(単一インスタンスのデータソースの場合は、DatasourceNameのままにしておくことができます) 文字列 「dataSource」:「HTTP_Page-C:」
データポイント 複数のデータポイントがコンマで区切られている、レポート用に選択されたデータポイント 文字列 「dataPoint」:「ResponseTime、Status」
アラートレベル 警告| エラー| クリティカル。 指定したデバイスおよびデバイスグループについて評価するアラートステータスの最小重大度。 文字列 「alertLevel」:「警告」
アラートルール 評価しているデータポイントアラートがルーティングされるアラートルールの名前。 正しいアラートルールを選択しないと、一致するアラートが表示されないことに注意してください 文字列 「alertRule」:「ProdServer Error / Critical」

アラートしきい値レポートのプロパティ

次のプロパティは、アラートしきい値レポートに固有です。

プロパティ

製品説明

種類

groupFullPath レポートにメンバーデバイスを含めるグループのフルパス。 グロブ式がサポートされています。 文字列 「groupFullPath」:「Production / Servers」
deviceDisplayName レポートに含めるデバイスの表示名。 グロブ式がサポートされています。 文字列 “deviceDisplayName”:”ip-172-31-33-214.us-west-2.compute.internal”
dataSourceInstanceName レポートに含めるデータソースインスタンスの名前。構文はdataSourceDisplayName-InstanceNameである必要があります。 単一インスタンスのデータソースを参照している場合は、dataSourceDisplayNameを指定するだけです。 グロブ式がサポートされています。 文字列 “ dataSourceInstanceName”:” *”
データポイント レポートに含まれるデータポイント。 グロブ式がサポートされています。 文字列 「dataPoint」:「*」
sortBy ホスト| データソース| データポイント

  • host:表示されるしきい値はデバイスごとに並べ替えられます
  • 情報源:表示されるしきい値はデータソースインスタンスごとに並べ替えられます
  • データポイント:表示されるしきい値はデータポイント(メトリック)でソートされます
文字列 「sortedBy」:「データソース」
除外グローバル
  • true:グローバルしきい値からの変動のみが表示されます
  • false:グローバルしきい値、カスタムグループ、インスタンスレベルのしきい値など、すべてのしきい値が表示されます
ブーリアン 「excludeGlobal」:true

アラートトレンドレポートのプロパティ

次のプロパティは、アラートトレンドレポートに固有です。

プロパティ

製品説明

種類

日付範囲 レポート用に構成された時間範囲:過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm 文字列 「dateRange」:「過去7日間」
メトリクス レポートに含まれるデバイスとグループ。各デバイス/グループは、itemTypeとitemValのXNUMXつのフィールドで表す必要があります。 JSONオブジェクト “metrics”:[{“itemType”:”host”,”itemVal”:”ip-172-31-33-214.us-west-2.compute.internal”},{“itemType”:”group”,”itemVal”:”Website”},{“itemType”:”host”,”itemVal”:”ip-172-31-37-162.us-west-2.compute.interal”}]

デバイスインベントリレポートのプロパティ

次のプロパティは、デバイスインベントリレポートに固有です。

プロパティ

製品説明

種類

hostsVal 複数のエンティティがコンマで区切られている、レポート用に選択されたデバイスまたはグループ(フルパス) 文字列 「hostsVal」:「AWS / EC2」
hostsValType ホスト| グループ。 hostsValフィールドで指定されたエンティティのタイプ。 文字列 「hostsValType」:「グループ」
sortBy レポートに表示されるデバイス/グループを並べ替えるために使用する必要がある「プロパティ」リストに含まれるプロパティを指定します 文字列 「sortedBy」:「system.aws.publicIpAddress」
プロパティ レポートに表示する必要のあるプロパティ JSONオブジェクト “ properties”:[“ system.aws.publicIpAddress”、” system.aws.resourceid”、” system.aws.region”、” system.aws.stateName”]

デバイスメトリックレポートのプロパティ

次のプロパティは、デバイスメトリックレポートに固有です。

プロパティ

製品説明

必須?

種類

日付範囲 レポート用に構成された時間範囲:過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm いいえ。デフォルトは過去2時間です。 文字列 「dateRange」:「過去14日間」
hostsVal レポート用に選択されたデバイスまたはグループの名前。複数のエンティティはコンマで区切られます。 グロブ式がサポートされています。 あり 文字列 “hostsVal”:”ip-172-31-33-214.us-west-2.compute.internal,ip-172-31-37-162.us-west-2.compute.interal”
hostsValType ホスト| グループ。 hostsValフィールドで指定されたエンティティのタイプ。 あり 文字列 「hostsValType」:「host」
sortBy ホスト| インスタンス| メトリック

  • host:レポートに表示される情報はデバイスごとに並べ替えられます
  • インスタンス:レポートに表示される情報はインスタンスごとに並べ替えられます
  • メトリック:レポートに表示される情報は、データポイント(メトリック)で並べ替えられます
いいえ。デフォルトはホストです。 文字列 「sortedBy」:「ホスト」
行フォーマット 0 | 1 | 2 | XnUMX

  • 0:テキストのみ–メトリックは表形式で表示されます。
  • 1:デバイスごとにXNUMXつのグラフ–メトリックは表形式で表示され、デバイスごとにXNUMXつのグラフが表示されます。
  • 2:インスタンスごとにXNUMXつのグラフ–メトリックは表形式で表示され、インスタンスごとにXNUMXつのグラフが表示されます。
  • 3:データポイントごとにXNUMXつのグラフ–メトリックは表形式で表示され、データポイントごとにXNUMXつのグラフが表示されます。
いいえ。デフォルトは0です。 整数 「rowFormat」:1
top10のみ 本当| 偽

  • false:選択したすべてのデバイスまたはグループのメトリックが表示されます
  • true:メトリックは、上位XNUMXのデバイスまたはグループに対してのみ表示されます
いいえ。デフォルトはfalseです。 ブーリアン 「top10Only」:false
メトリクス レポートに含まれるデータポイントまたはデータポイントの計算。各データポイント/計算は、dataSourceId、インスタンス(globは問題ありません)、metric(globなし)のXNUMXつのフィールドで指定されます。 あり JSONオブジェクト 「metrics」:[{"dataSourceId":699、 "instances": "script"、 "metric": "SuccessExecuteTime"}]
コラム レポートに表示される列。 表示する順序で列を指定する必要があります。 このオブジェクトにはすべての列名を含める必要がありますが、各列には、表示されるかどうかを示すisHiddenフィールドが関連付けられている必要があります。 いいえ。デフォルトでは、すべての列が表示されます。 JSONオブジェクト “ columns”:[{“ name”:” Device”、” isHidden”:true}、{“ name”:” Instance”、” isHidden”:false}、{“ name”:” Datapoint”、” isHidden”: false}、{“ name”:” Start”、” isHidden”:true}、{“ name”:” End”、” isHidden”:true}、{“ name”:” Min”、” isHidden”:false} 、{“ name”:” Max”、” isHidden”:false}、{“ name”:” Average”、” isHidden”:false}、{“ name”:” Change(%)”、” isHidden”:false }]

インターフェイス帯域幅レポートのプロパティ

次のプロパティは、インターフェイス帯域幅レポートに固有です。

プロパティ

製品説明

種類

日付範囲 レポート用に構成された時間範囲。 過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm 文字列 「dateRange」:「過去14日間」
hostsVal 複数のエンティティがコンマで区切られている、レポート用に選択されたデバイスまたはグループ 文字列 “hostsVal”:”ip-172-31-33-214.us-west-2.compute.internal,ip-172-31-37-162.us-west-2.compute.interal”
hostsValType ホスト| グループ。 hostsValフィールドで指定されたエンティティのタイプ。 文字列 「hostsValType」:「host」
行フォーマット 0 | 1

  • 0:テキストのみ–メトリックは表形式で表示されます。
  • 1:インスタンスごとにXNUMXつのグラフ–メトリックは表形式で表示され、インスタンスごとにXNUMXつのグラフが表示されます。
整数 「rowFormat」:1

Netflowデバイスレポートのプロパティ

次のプロパティは、Netflowデバイスレポートに固有です。

プロパティ

製品説明

種類

hostsVal レポート用に選択されたデバイスORグループ(フルパス)。複数のエンティティはコンマで区切られます。 グロブは受け入れられます。 文字列 “hostsVal”:”ip-172-31-33-214.us-west-2.compute.internal”
日付範囲 レポート用に構成された時間範囲:過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm 文字列 「dateRange」:「過去2時間」

サーバーCPUレポートのプロパティ

次のプロパティは、サーバーCPUレポートに固有です。

プロパティ

製品説明

種類

日付範囲 レポート用に構成された時間範囲:過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm 文字列 「dateRange」:「過去2時間」
hostsVal 複数のデバイスがコンマで区切られている、レポート用に選択されたグループ 文字列 “hostsVal”:”ip-172-31-33-214.us-west-2.compute.internal,ip-172-31-37-162.us-west-2.compute.interal”
top10のみ 本当| 偽

  • false:選択したすべてのデバイスまたはグループのCPUメトリックが表示されます
  • true:CPUメトリックは、上位XNUMX個のデバイスまたはグループに対してのみ表示されます
ブーリアン 「top10Only」:true
表示グラフ true | false。 レポートの最後にCPUグラフを表示するかどうか ブーリアン 「displayGraphs」:true

SLAレポートのプロパティ

次のプロパティは、SLAレポートに固有です。

プロパティ

製品説明

種類

日付範囲 レポート用に構成された時間範囲:過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm 文字列 「dateRange」:「過去30日間」
メトリクス レポートに含まれるデータポイントと対応するSLAしきい値。各メトリックには、groupName、deviceName、dataSourceFullName、dataSourceId、instances、metric、thresholdのXNUMXつのフィールドが含まれます。 しきい値は、演算子とスペースで区切られた数値で構成する必要があります。有効な演算子は、>、<、!=、=、> =、および<=です。 JSONオブジェクト 「metrics」:[{"groupName": "*"、 "deviceName": "*"、 "dataSourceId":368、 "dataSourceFullName": "*"、 "instances": "*"、 "metric": "UptimeMinutes ”、”しきい値”:”> 0”}]
dayInOneWeek SLAレポートで考慮すべき曜日。複数の値はコンマで区切られ、*はすべての曜日を示します。 文字列 「dayInOneWeek」:「*」
periodInOneDay SLAレポートで考慮すべき選択した各日の時間。*はすべての時間を指します。 文字列 「periodInOneDay」:「*」
表示概要 trueの場合、SLAの概要(合計%)が表示されます ブーリアン 「displaySummary」:false
監視されていない時間 0 | 1 | 2 –デバイスのデータがない時間をカウントする方法。1=データなしを無視(合計時間から減算)、2 =違反としてカウント(稼働時間から減算)、3 =使用可能としてカウント(稼働時間に追加) 整数 「unmonitoredTime」:1
displayWithAvailability trueの場合、可用性が100%未満のデバイスのみがレポートに表示されます。 ブーリアン 「displayWithAvailability」:false
コラム レポートに表示される列 JSONオブジェクト “ columns”:[{“ name”:” Device”、” isHidden”:false}、{“ name”:” Datasource”、” isHidden”:false}、{“ name”:” Instance”、” isHidden”: false}、{“ name”:” Datapoint”、” isHidden”:false}、{“ name”:” Threshold”、” isHidden”:false}、{“ name”:” Available”、” isHidden”:false} 、{“ name”:” Unavailable”、” isHidden”:false}]

Webサイトサービスの概要レポートのプロパティ

次のプロパティは、Webサイトサービス概要レポートに固有です。

プロパティ

製品説明

種類

servicesVal レポート用に選択されたサービスまたはサービスグル​​ープ(フルパス)。複数のエンティティはコンマで区切られます 文字列 「servicesVal」:「CName_check」
servicesValType サービス| グループ。 servicesValフィールドで指定されたエンティティのタイプ。 文字列 「servicesValType」:「service」
日付範囲 レポート用に構成された時間範囲:過去2時間| 過去24時間| 最終暦日| 過去7日間| 過去14日間| 過去30日間| 先月| 過去365日| この形式のカスタム日付範囲:YYYY-MM-dd hh:mmからYYYY-MM-dd hh:mm 文字列 「dateRange」:「過去2時間」
画面タイプ 1 | 2

  • 1:全体の場所を表示する
  • 2:全体および個々の場所を表示する
整数 「displayType」:1
インクルードタイプ レポートに含める必要のある情報。 オプションには、1:可用性、2:アラート、3:グラフが含まれます JSONオブジェクト 「includeTypes」:[1,2,3]

記事上で