サンプル統計値表示 (GET /v2/meters/{meter_name}/statistics)
指定された期間内のサンプルの統計値を取得します。
{meter_name}:サンプルを取得する監視項目名を指定します。
Request Headers
「API共通項目」を参照してください。
Request Parameter
q.field
以下の検索対象のフィールドを指定します。
- resource_id:リソースID。
- source:監視項目のソース。
- timestamp:集計開始/終了時刻
- timestampの指定を省略した場合は、集計開始時刻として「timestamp≧現在時刻-(period×1440)」(注)、集計終了時刻として「timestamp<現在時刻」の検索条件が設定されます(periodが60(秒)の場合は1日分となる範囲です)。
- timestampの集計開始時刻のみを指定した場合は、集計終了時刻として「集計開始時刻+(period×1440)>timestamp」(注)の検索条件が設定されます。
- timestampの集計終了時刻のみを指定した場合は、集計開始時刻として「集計終了時刻-(period×1440)≦timestamp」(注)の検索条件が設定されます。
- timestampの集計開始時刻と集計終了時刻の範囲(秒)が、period×1440の値よりも大きい場合はエラーになります。
(注):period×1440の値が1209600(2週間)以上になる場合は、1209600として扱います。
- user_id:監視項目を登録したユーザーID。
未指定の場合は、対象の監視項目名の全サンプルの集計結果を出力します。
Data Type | Cardinality |
---|---|
String | 0..10 |
q.op
以下の比較演算子を指定します。
- q.fieldがresource_idの場合
eq:等しい
- q.fieldがsourceの場合
eq:等しい
- q.fieldがtimestampの場合
gt:より大きい
ge:より大きいか等しい
lt:より小さい
le:より小さいか等しい
- q.fieldがuser_idの場合
eq:等しい
未指定の場合は、"eq"が設定されます。
Data Type | Cardinality |
---|---|
String | 0..10 |
q.value
以下の比較対象データの値を指定します。
- q.fieldがresource_idの場合
リソースID
- q.fieldがsourceの場合
ソース
- q.fieldがtimestampの場合
日時(YYYY-MM-DDThh:mm:ss)
- q.fieldがuser_idの場合
ユーザーID
使用可能文字:全角文字、半角英数字、半角記号
文字数:1~255文字
Data Type | Cardinality |
---|---|
String | 0..10 |
groupby
フィールド単位で集計する場合に、以下のフィールドを指定します。
- resoruce_id
- user_id
未指定の場合はフィールド単位の集計は行いません。
Data Type | Cardinality |
---|---|
String | 0..1 |
period
集計間隔(秒)を指定します。
範囲:60~1209600 (60の倍数のみ指定可能です)
未指定の場合は、指定された範囲の全サンプルの集計結果を出力します。
Data Type | Cardinality |
---|---|
int | 0..1 |
aggregate.func
以下の集計関数を指定します。
- avg:平均値
- count:サンプル数
- max:最大値
- min:最小値
- sum:合計値
未指定の場合は、全ての集計関数の結果が出力されます。
Data Type | Cardinality |
---|---|
Stinrg | 0..10 |
Response Headers
ステータス
正常の場合は以下のステータスを返却します。
200:正常終了
異常の場合は、「API共通エラー情報」を参照してください。
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response Elements
集計結果のリストをJSON形式で返します。
内容の詳細は、「type Statistics」を参照してください。
Example of Request
例1:サンプルの日時と"groupby"にユーザーIDを指定して、特定の時間範囲におけるユーザーごとの統計値を取得します。
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/meters/my_meter/statistics?groupby=user_id&q.field=timestamp&q.op=gt&q.value=2014-10-22T00:00:00&
q.field=timestamp&q.op=lt&q.value=2014-10-23T00:00:00'
例2:集計間隔と集計関数を指定して、一時間ごとの最大値、最小値の値を取得します。
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/meters/my_meter/statistics?period=3600&aggregate.func=max&aggregate.func=min'
Example of Response
[
{
"avg": 0.041790414908881302,
"count": 1716,
"duration": 89950.0,
"duration_end": "2014-10-23T00:59:22",
"duration_start": "2014-10-22T00:00:12",
"groupby": {
"user_id": "f2ee0c983abf4c65aa44b3328b8a484f"
},
"max": 0.314285714285714,
"min": 0.0172413793103448,
"period": 0,
"period_end": "2014-10-23T00:59:22",
"period_start": "2014-10-22T00:00:12",
"sum": 71.712351983640303,
"unit": "%"
},
{
"avg": 0.048886882955332202,
"count": 905,
"duration": 89858.0,
"duration_end": "2014-10-23T00:59:05",
"duration_start": "2014-10-22T00:01:27",
"groupby": {
"user_id": "0d6293fbdf8948f090b8195bebd8ee8b"
},
"max": 0.36956521739130399,
"min": 0.0280373831775701,
"period": 0,
"period_end": "2014-10-23T00:59:05",
"period_start": "2014-10-22T00:01:27",
"sum": 44.242629074575603,
"unit": "%"
}
]