監視項目一覧取得 (GET /v2/meters)
指定されたクエリに基づいて、すべての監視項目を取得します。
Request Headers
「API共通項目」を参照してください。
Request Parameter
q.field
以下の検索対象のフィールドを指定します。
- resource_id:リソースID。
- source:監視項目のソース。
- user_id:監視項目を登録したユーザーID。
未指定の場合は、すべての監視項目を取得します。
Data Type | Cardinality |
---|---|
String | 0..10 |
q.op
以下の比較演算子を指定します。
- q.fieldがresource_idの場合
eq:等しい
- q.fieldがsourceの場合
eq:等しい
- q.fieldがuser_idの場合
eq:等しい
未指定の場合は、"eq"が設定されます。
Data Type | Cardinality |
---|---|
String | 0..10 |
q.value
比較対象データの値。
以下の比較対象データの値を指定します。
- q.fieldがresource_idの場合
リソースID
- q.fieldがsourceの場合
ソース
- q.fieldがuser_idの場合
ユーザーID
使用可能文字:全角文字、半角英数字、半角記号
文字数: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 Meter」を参照してください。
Example of Request
例1:すべての監視項目の一覧を取得する。
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/meters'
例2:ユーザーIDとリソースIDを指定して、特定のユーザー、リソースに関する監視項目の一覧を取得する。
curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/meters?q.field=
user_id&q.op=eq&q.value=0382c98eaf574d1ab5751a3e938b744d&q.field=
resource_id&q.op=eq&q.value=my_resource
Example of Response
[
{
"meter_id": "ZGVtb19yZXNvdXJjZTAwMyt0ZXN0bWV0ZXIwMDU=\n",
"name": "my_meter",
"project_id": "610678ac162147c4a5e838190a80994e",
"resource_id": "my_resource",
"source": "89b0b9f21b414cd39354a1b8056aef87:my_source",
"type": "gauge",
"unit": "test",
"user_id": "0382c98eaf574d1ab5751a3e938b744d"
},
{
"meter_id": "ZGVtb19yZXNvdXJjZTAwMyt0ZXN0bWV0ZXIwMDY=\n",
"name": "my_meter",
"project_id": "610678ac162147c4a5e838190a80994e",
"resource_id": "my_resource2",
"source": "89b0b9f21b414cd39354a1b8056aef87:my_source",
"type": "gauge",
"unit": "test",
"user_id": "0382c98eaf574d1ab5751a3e938b744d"
}
]