1. index
  2. 監視
  3. 設定
  4. コマンド
  5. その他

comment オブジェクト

commentオブジェクトは、X-MONのコメント情報を操作するオブジェクトです。

comment.getコメントの取得

comment.getは、コメントの情報を取得するためのメソッドです。

対応X-MONバージョン
  • 3.0.9 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

閲覧者権限のユーザは、閲覧対象ホストグループが設定されている場合、閲覧対象として許可されているコメント情報のみが取得されます。

リクエストパラメータ

カラム名称 概要
id string

指定したIDのコメント情報を取得します。

contact_name string

指定したユーザIDで絞り込みを行います。

host_name string

指定したホストIDで絞り込みを行います。

service_description string

指定したサービスIDで絞り込みを行います。

host_nameが指定されていない場合は、無視されます。

host_group
3.5.0 以降
string

指定したホストグループIDで絞り込みを行います。

limit
3.5.0 以降
integer

検索時に取得する件数を指定します。

省略時は、全件が取得されます。

レスポンスカラム

カラム名称 概要
id string

コメントID

host_name string

ホストID

service_description string

サービスID

title string

コメントのタイトル

comment string

コメントの本文

alias string

コメントの投稿者のエイリアス

contact_name string

コメントの投稿者のユーザID

create_date string

コメントの投稿日時

update_date string

コメントの更新日時

report boolean

簡易レポートの出力設定

true
簡易レポートに出力を行う
false
簡易レポートに出力を行わない
cnt integer

返信件数

res array

返信の詳細

idを指定した場合のみ取得されます