これは開発版のドキュメントを表示しています。内容が不完全な場合があります。
このページには自動翻訳されたコンテンツが含まれています。 誤りを見つけた場合は、その箇所を選択して Ctrl+Enter を押し、編集者に報告してください。

housekeeping.get

説明

object housekeeping.get(object parameters)

このメソッドは、指定されたパラメータに従ってハウスキーピングオブジェクトを取得することができます。

このメソッドは、すべての種類のユーザーが利用できます。 メソッドの呼び出し権限は、ユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメータ

(object) 望ましい出力を定義するパラメータ。

このメソッドは1つのパラメータのみをサポートします。

パラメータ タイプ 説明
output query このパラメータについてはリファレンス解説で説明されています。

戻り値

(object) housekeeping オブジェクトを返します

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "housekeeping.get",
           "params": {
               "output": "extend"
           },
           "id": 1
       }

レスポンス:

{
           "jsonrpc": "2.0",
           "result": {
               "hk_events_mode": "1",
               "hk_events_trigger": "365d",
               "hk_events_service": "1d",
               "hk_events_internal": "1d",
               "hk_events_discovery": "1d",
               "hk_events_autoreg": "1d",
               "hk_services_mode": "1",
               "hk_services": "365d",
               "hk_audit_mode": "1",
               "hk_audit": "31d",
               "hk_sessions_mode": "1",
               "hk_sessions": "365d",
               "hk_history_mode": "1",
               "hk_history_global": "0",
               "hk_history": "31d",
               "hk_trends_mode": "1",
               "hk_trends_global": "0",
               "hk_trends": "365d",
               "db_extension": "",
               "compression_status": "0",
               "compress_older": "7d"
           },
           "id": 1
       }

ソース

CHousekeeping ::get() in ui/include/classes/api/services/CHousekeeping.php.