5.11.1 メトリック一覧取得
- 機能
-
指定したIM管理ノードのSIDで取得可能な時系列データのメトリック一覧を取得します。
- 実行権限
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
POST /application/component/apiVersion/nodes/metrics httpVersion
- リクエストのメッセージボディー
{ "sid" : IM管理ノードのSID }
- レスポンスのメッセージボディー
{ "metrics": [ { "name": メトリック, "label": メトリック表示名, "category": メトリックのカテゴリ, "description": メトリックの説明, "default": デフォルトの設定 } … ] }
- パラメーター
-
- sid
-
SID(管理オブジェクトID)を指定します。このパラメーターは省略できません。
- ステータスコード
-
ステータスコード
メッセージ
説明
200
なし
メトリック一覧取得REST APIの処理が成功しました。
400
KAJY22009-E
メトリック一覧取得REST APIのパラメーターの指定が不正なため,メトリック一覧取得REST APIを実行できません。
KAJY22011-E
存在しないSIDが指定されています。
403
KAJY01000-E
REST APIの実行権限がありません。
500
KAJY22007-E
メトリック一覧の取得に失敗しました。
KAJY22008-E
取得したデータが不正です。
- 戻り値
-
ステータスコードが200の場合に,レスポンスボディーに次の情報を返却します。
項番
メンバー名
データ型
説明
1
metrics
object[]
取得したメトリック一覧を配列として返却します。
2
name
string
メトリック名が設定されます。
3
label
string
メトリックの表示名称が設定されます。
設定されていない場合は,省略されます。
4
category
string
メトリックのカテゴリが設定されます。
設定されていない場合は,省略されます。
5
description
string
メトリックの説明が設定されます。
設定されていない場合は,省略されます。
6
default
boolean
デフォルトのメトリック名かどうかが設定されます。
-
true:デフォルトのメトリック
-
false:デフォルト以外のメトリック
-
- 使用例
-
管理オブジェクトであるPFMエージェントのサービス(sid:_JP1PFM-M_HOST2/_JP1PFM-AHOST_HOST20/_HOST_HOST20/_JP1PFM-A_serviceID)のメトリック一覧を取得するAPIの使用例を次に示します。
- リクエスト:
POST http://hostname:20703/im/api/v1/nodes/metrics { "sid":"_JP1PFM-M_HOST2/_JP1PFM-AHOST_HOST20/_HOST_HOST20/_JP1PFM-A_serviceID" }
- レスポンス:
{ "metrics": [ { "name":"cpu_used_rate", "label":"CPU使用率", "description":"プロセッサの使用率(%)。プロセッサが非アイドル状態のスレッドを実行した経過時間の割合。(単位:%)", "default":true } … ] }