ターゲットのメトリック・グループの取得
get
http://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targets/{targetId}/metricGroups
指定されたターゲットのすべてのメトリック・グループを、メトリック・グループの名前順にリストします。include= metricsを指定すると、グループ内のメトリックの詳細が含まれます。
リクエスト
パス・パラメータ
- targetId(必須): string
ターゲットID (つまり、ターゲットGUID)例:
CF99A10F233254B78ED96ED1B5C15140
問合せパラメータ
- include: string[]
最大長:
32
オプションのパラメータ。include= metricsを指定すると、グループ内のメトリックの詳細が含まれます。-
指定可能な値:
[ "metrics" ]
例:metrics
-
この操作にはリクエスト本文はありません。
先頭に戻るレスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: MetricGroupCollection
型:
object
名前順のメトリック・グループのリスト。
ソースの表示
-
count(必須): integer
返されたリスト内のメトリック・グループの数例:
10
-
items(必須): array items
名前順のメトリック・グループのリスト。
-
links(必須): object links
ナビゲーション・リンク
ネストされたスキーマ: links
型:
object
ナビゲーション・リンク
ソースの表示
例:
{
"self":{
"href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups"
}
}
ネストされたスキーマ: MetricGroup
型:
object
メトリック・グループ・メタデータ
ソースの表示
-
displayName(必須): string
ローカライズされたメトリック・グループ名例:
File Systems
-
id(必須): string
最大長:
32
メトリック・グループID例:34E542C4F1CF2743327ED2F8563D1E4B
-
isMetricExtension(必須): boolean
デフォルト値:
false
これがメトリック拡張の場合はTrue、そうでない場合はfalse -
keys: array keys
(オプション)このメトリック・グループのキーのリスト(存在する場合)。問合せパラメータinclude= metricsが指定されている場合に含まれます。
-
links(必須): object links
ナビゲーション・リンク
-
metrics: array metrics
(オプション)このメトリック・グループ内に存在するメトリックのリスト。問合せパラメータinclude= metricsが指定されている場合に含まれます。
-
name(必須): string
最大長:
64
メトリック・グループ名例:Filesystems
ネストされたスキーマ: keys
型:
array
(オプション)このメトリック・グループのキーのリスト(存在する場合)。問合せパラメータinclude= metricsが指定されている場合に含まれます。
ソースの表示
- 配列: object MetricKey
メトリック・キー・メタデータ
例:
[
{
"name":"mountPoint",
"displayName":"Mount Point"
}
]
ネストされたスキーマ: links
型:
object
ナビゲーション・リンク
ソースの表示
例:
{
"self":{
"href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems"
}
}
ネストされたスキーマ: metrics
型:
array
(オプション)このメトリック・グループ内に存在するメトリックのリスト。問合せパラメータinclude= metricsが指定されている場合に含まれます。
ソースの表示
- 配列: object Metric
メトリック・メタデータ
例:
[
{
"id":"6E65075DA52ACA744B4B8C3FCB018289",
"name":"pctAvailable",
"displayName":"Filesystem Space Available (%)",
"dataType":"NUMBER",
"categoryName":"Utilization",
"unitDisplayName":"%"
},
{
"id":"162045AD9191652427CAC47D8BA40671",
"name":"size",
"displayName":"Filesystem Size (MB)",
"dataType":"NUMBER",
"unitDisplayName":"MB"
},
{
"id":"E8838C71E687BF0A9E02FFACC0C9AC80",
"name":"available",
"displayName":"Filesystem Space Available (MB)",
"dataType":"NUMBER",
"categoryName":"Utilization",
"unitDisplayName":"MB"
},
{
"id":"C80F6EAA9145C76D30DE8705346D5AAA",
"name":"fileSystem",
"displayName":"Filesystem",
"dataType":"STRING"
}
]
ネストされたスキーマ: MetricKey
型:
object
メトリック・キー・メタデータ
ソースの表示
-
displayName(必須): string
キー表示名例:
Mount Point
-
name(必須): string
最大長:
64
キー名例:mountPoint
ネストされたスキーマ: Link
型:
object
リンクを表します(self、previous、nextのいずれか)
ソースの表示
-
href: string
リンクのためのURL例:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
ネストされたスキーマ: Metric
型:
object
メトリック・メタデータ
ソースの表示
-
categoryDisplayName: string
メトリック・カテゴリ表示名例:
Utilization
-
categoryName: string
メトリック・カテゴリ名例:
Utilization
-
dataType(必須): string
指定可能な値:
[ "NUMBER", "STRING" ]
メトリック・データ型。列挙される値は、時間の経過とともに増加する可能性があります。不明な値が見つかった場合は、互換性のためにそれをSTRINGとして扱います。例:NUMBER
-
displayName(必須): string
メトリック表示名例:
Filesystem Size (MB)
-
id(必須): string
最大長:
32
メトリックID例:E8838C71E687BF0A9E02FFACC0C9AC80
-
name(必須): string
最大長:
64
メトリック名例:size
-
unitDisplayName: string
メトリック単位表示名例:
MB
例
400レスポンス
不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
401レスポンス
未認可。ユーザーにはリクエストされた操作を実行する権限がありません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
404レスポンス
見つかりません。リクエストされたREST API URLが見つかりません。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
500レスポンス
内部サーバー・エラー。REST APIの実行中に例外が発生しました。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
503レスポンス
サービスが使用できません。サーバーはリクエストを処理できません。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列