Documentation
trend.get
説明
integer/array trend.get(object parameters)
このメソッドでは、指定されたパラメーターを基にトレンドデータを取得できます。
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で 取り消すことができます。詳しくはユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメーター
このメソッドは、次のパラメーターをサポートします。
| パラメータ | タイプ | 説明 |
|---|---|---|
| itemids | string/array | 指定されたアイテムIDのトレンドのみを返します |
| time_from | timestamp | 指定された時間以降またはその時点で収集された値のみを返します |
| time_till | timestamp | 指定された時間より前またはその時点で収集された値のみを返します |
| countOutput | boolean | 取得したオブジェクトの数を数えます |
| limit | integer | 取得するオブジェクトの量を制限します |
| output | query | 出力フィールドを設定します |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
アイテムのトレンドデータ取得
Request:
{
"jsonrpc": "2.0",
"method": "trend.get",
"params": {
"output": [
"itemid",
"clock",
"num",
"value_min",
"value_avg",
"value_max",
],
"itemids": [
"23715"
],
"limit": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23715",
"clock": "1446199200",
"num": "60",
"value_min": "0.165",
"value_avg": "0.2168",
"value_max": "0.35",
}
],
"id": 1
}ソース
CTrend::get() in ui/include/classes/api/services/CTrend.php.