Get metric group details for a target
get
http://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targets/{targetId}/metricGroups/{metricGroupName}
Returns details of the specified metric group and its metrics for the target.
Request
Path Parameters
-
metricGroupName(required): string
Metric Group NameExample:
Filesystems
-
targetId(required): string
Target ID (.i.e, Target GUID)Example:
CF99A10F233254B78ED96ED1B5C15140
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : MetricGroup
Type:
object
Metric group metadata
Show Source
-
displayName(required): string
Localized Metric group nameExample:
File Systems
-
id(required): string
Maximum Length:
32
Metric group IDExample:34E542C4F1CF2743327ED2F8563D1E4B
-
isMetricExtension(required): boolean
Default Value:
false
True if this is a metric extension, false otherwise -
keys: array
keys
(Optional) List of keys for this metric group, if present. Included if query parameter include=metrics is specified.
-
links(required): object
links
Navigations links
-
metrics: array
metrics
(Optional) List of metrics present in this metric group. Included if query parameter include=metrics is specified.
-
name(required): string
Maximum Length:
64
Metric group nameExample:Filesystems
Nested Schema : keys
Type:
array
(Optional) List of keys for this metric group, if present. Included if query parameter include=metrics is specified.
Show Source
-
Array of:
object MetricKey
Metric key metadata
Example:
[
{
"name":"mountPoint",
"displayName":"Mount Point"
}
]
Nested Schema : links
Type:
object
Navigations links
Show Source
Example:
{
"self":{
"href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems"
}
}
Nested Schema : metrics
Type:
array
(Optional) List of metrics present in this metric group. Included if query parameter include=metrics is specified.
Show Source
-
Array of:
object Metric
Metric metadata
Example:
[
{
"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"
}
]
Nested Schema : MetricKey
Type:
object
Metric key metadata
Show Source
-
displayName(required): string
Key display nameExample:
Mount Point
-
name(required): string
Maximum Length:
64
Key nameExample:mountPoint
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
Nested Schema : Metric
Type:
object
Metric metadata
Show Source
-
categoryDisplayName: string
Metric Category Display NameExample:
Utilization
-
categoryName: string
Metric Category NameExample:
Utilization
-
dataType(required): string
Allowed Values:
[ "NUMBER", "STRING" ]
Metric Data type. Its enumerated values could be expanded over time. If an unknown value is encountered, treat it as STRING for compatibility.Example:NUMBER
-
displayName(required): string
Metric Display NameExample:
Filesystem Size (MB)
-
id(required): string
Maximum Length:
32
Metric IDExample:E8838C71E687BF0A9E02FFACC0C9AC80
-
name(required): string
Maximum Length:
64
Metric NameExample:size
-
unitDisplayName: string
Metric Unit Display NameExample:
MB
Examples
400 Response
Bad Request. The payload is null or missing some parameters
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
404 Response
Not Found. The requested REST API URL is not found.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error. Exception in execution of REST API.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable. The server is unable to process the request.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string