サンプル一覧取得(GET /v2/meters/{meter_name})
指定された監視項目のサンプルを取得します。
{meter_name}:サンプルを取得する監視項目名を指定します。
Request Headers
「API共通項目」を参照してください。
Request Parameter
q.field
以下の検索対象のフィールドを指定します。
- resource_id:リソースID。
- source:監視項目のソース。
- timestamp:サンプルの日時。
- timestampの指定を省略した場合は、timestampの範囲として「現在時刻-1日≦timestamp<現在時刻」となる検索条件が設定されます。
- timestampの起点時刻のみを指定した場合は、終点時刻として「起点時刻+1日>timestamp」の検索条件が設定されます。
- timestampの終点時刻のみを指定した場合は、起点時刻として「終点時刻-1日≦timestamp」の検索条件が設定されます。
- 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:より小さいか等しい
未指定の場合は、"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)
使用可能文字:全角文字、半角英数字、半角記号
文字数:1~255文字
Data Type | Cardinality |
---|---|
String | 0..10 |
limit
取得するサンプルの最大数を指定します。
範囲:1~1440
未指定の場合は、1440が設定されます。
Data Type | Cardinality |
---|---|
Int | 0..1 |
offset
取得するサンプルのオフセットとなる件数を指定します。
未指定の場合は、0が設定されます。
Data Type | Cardinality |
---|---|
Int | 0..1 |
Response Headers
ステータス
正常の場合は以下のステータスを返却します。
200:正常終了
異常の場合は、「API共通エラー情報」を参照してください。
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response Elements
指定された条件に基づいて取得した監視項目のサンプルのリストをJSON形式で返します。
内容の詳細は、「type OldSample」を参照してください。
Example of Request
例1:サンプルの日時を指定して、特定の時間範囲のサンプルを取得する。
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/meters/my_meter?
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:リソースIDを指定して、特定のリソースに関するサンプルを取得する
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/meters/my_meter?q.field=resource_id&q.op=eq&q.value=my_resource'
Example of Response
[
{
"counter_name": "my_meter",
"counter_type": "gauge",
"counter_unit": "%",
"counter_volume": 0.0,
"project_id": "bc835c72f50b48c89ad7ee8a89806bb1",
"recorded_at": "2014-10-22T00:02:50.171418",
"resource_id": "my_resource",
"resource_metadata": {
"my_metadata": "test",
},
"source": "bc835c72f50b48c89ad7ee8a89806bb1:my_source",
"timestamp": "2014-10-22T00:02:49",
"user_id": "22fa5e38788d40988b8aa28e749f7a84"
},
{
"counter_name": "my_meter",
"counter_type": "gauge",
"counter_unit": "%",
"counter_volume": 10.0,
"project_id": "bc835c72f50b48c89ad7ee8a89806bb1",
"recorded_at": "2014-10-22T00:01:12.511325",
"resource_id": "my_resource",
"resource_metadata": {
"my_metadata": "test",
},
"source": "bc835c72f50b48c89ad7ee8a89806bb1:my_source",
"timestamp": "2014-10-22T00:01:12",
"user_id": "22fa5e38788d40988b8aa28e749f7a84"
},
]