Jump to

• Request
• Response

Get metric groups for the target

get

http://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targets/{targetId}/metricGroups

List all the metrics groups of the specified target, ordered by metric group name. When include=metrics is specified, it includes details of the metrics in the group.

Request

Path Parameters

• targetId(required): string
  Target ID (.i.e, Target GUID)

  Example:

  CF99A10F233254B78ED96ED1B5C15140

Query Parameters

• include: string[]
  Maximum Length: 32

  Optional parameter. When include=metrics is specified, it includes details of the metrics in the group.

  • Allowed Values: [ "metrics" ]

  [
      "metrics"
  ]

  Example:

  metrics

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : MetricGroupCollection

Type: object

List of metric groups ordered by name.

Show Source

• count(required): integer
  Number of metric groups in returned list

  Example: 10
• items(required): array items
  List of metric groups ordered by name.
• links(required): object links
  Navigations links

{
    "type":"object",
    "description":"List of metric groups ordered by name.",
    "required":[
        "count",
        "items",
        "links"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of metric groups in returned list",
            "example":10
        },
        "items":{
            "description":"List of metric groups ordered by name.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetricGroup"
            }
        },
        "links":{
            "type":"object",
            "description":"Navigations links",
            "properties":{
                "self":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                }
            },
            "example":{
                "self":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups"
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of metric groups ordered by name.

Show Source

• Array of: object MetricGroup
  Metric group metadata

{
    "description":"List of metric groups ordered by name.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MetricGroup"
    }
}

Nested Schema : links

Type: object

Navigations links

Show Source

• self: object self

{
    "type":"object",
    "description":"Navigations links",
    "properties":{
        "self":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        }
    },
    "example":{
        "self":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups"
        }
    }
}

Example:

{
    "self":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups"
    }
}

Nested Schema : MetricGroup

Type: object

Metric group metadata

Show Source

• displayName(required): string
  Localized Metric group name

  Example: File Systems
• id(required): string
  Maximum Length: 32

  Metric group ID

  Example: 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 name

  Example: Filesystems

{
    "description":"Metric group metadata",
    "type":"object",
    "required":[
        "id",
        "name",
        "displayName",
        "isMetricExtension",
        "links"
    ],
    "properties":{
        "id":{
            "type":"string",
            "maxLength":32,
            "description":"Metric group ID",
            "example":"34E542C4F1CF2743327ED2F8563D1E4B"
        },
        "name":{
            "type":"string",
            "maxLength":64,
            "description":"Metric group name",
            "example":"Filesystems"
        },
        "displayName":{
            "type":"string",
            "description":"Localized Metric group name",
            "example":"File Systems"
        },
        "isMetricExtension":{
            "type":"boolean",
            "default":false,
            "description":"True if this is a metric extension, false otherwise"
        },
        "links":{
            "type":"object",
            "description":"Navigations links",
            "properties":{
                "self":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                }
            },
            "example":{
                "self":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems"
                }
            }
        },
        "keys":{
            "type":"array",
            "description":"(Optional) List of keys for this metric group, if present. Included if query parameter include=metrics is specified.",
            "items":{
                "$ref":"#/components/schemas/MetricKey"
            },
            "example":[
                {
                    "name":"mountPoint",
                    "displayName":"Mount Point"
                }
            ]
        },
        "metrics":{
            "type":"array",
            "description":"(Optional) List of metrics present in this metric group. Included if query parameter include=metrics is specified.",
            "items":{
                "$ref":"#/components/schemas/Metric"
            },
            "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 : 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

{
    "type":"array",
    "description":"(Optional) List of keys for this metric group, if present. Included if query parameter include=metrics is specified.",
    "items":{
        "$ref":"#/components/schemas/MetricKey"
    },
    "example":[
        {
            "name":"mountPoint",
            "displayName":"Mount Point"
        }
    ]
}

Example:

[
    {
        "name":"mountPoint",
        "displayName":"Mount Point"
    }
]

Nested Schema : links

Type: object

Navigations links

Show Source

• self: object self

{
    "type":"object",
    "description":"Navigations links",
    "properties":{
        "self":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        }
    },
    "example":{
        "self":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems"
        }
    }
}

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

{
    "type":"array",
    "description":"(Optional) List of metrics present in this metric group. Included if query parameter include=metrics is specified.",
    "items":{
        "$ref":"#/components/schemas/Metric"
    },
    "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"
        }
    ]
}

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 name

  Example: Mount Point
• name(required): string
  Maximum Length: 64

  Key name

  Example: mountPoint

{
    "type":"object",
    "description":"Metric key metadata",
    "required":[
        "name",
        "displayName"
    ],
    "properties":{
        "name":{
            "type":"string",
            "maxLength":64,
            "description":"Key name",
            "example":"mountPoint"
        },
        "displayName":{
            "type":"string",
            "description":"Key display name",
            "example":"Mount Point"
        }
    }
}

Nested Schema : self

Type: object

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        }
    ]
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Nested Schema : Metric

Type: object

Metric metadata

Show Source

• categoryDisplayName: string
  Metric Category Display Name

  Example: Utilization
• categoryName: string
  Metric Category Name

  Example: 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 Name

  Example: Filesystem Size (MB)
• id(required): string
  Maximum Length: 32

  Metric ID

  Example: E8838C71E687BF0A9E02FFACC0C9AC80
• name(required): string
  Maximum Length: 64

  Metric Name

  Example: size
• unitDisplayName: string
  Metric Unit Display Name

  Example: MB

{
    "type":"object",
    "description":"Metric metadata",
    "required":[
        "id",
        "name",
        "displayName",
        "dataType"
    ],
    "properties":{
        "id":{
            "type":"string",
            "maxLength":32,
            "description":"Metric ID",
            "example":"E8838C71E687BF0A9E02FFACC0C9AC80"
        },
        "name":{
            "type":"string",
            "maxLength":64,
            "description":"Metric Name",
            "example":"size"
        },
        "displayName":{
            "type":"string",
            "description":"Metric Display Name",
            "example":"Filesystem Size (MB)"
        },
        "categoryName":{
            "type":"string",
            "description":"Metric Category Name",
            "example":"Utilization"
        },
        "categoryDisplayName":{
            "type":"string",
            "description":"Metric Category Display Name",
            "example":"Utilization"
        },
        "dataType":{
            "type":"string",
            "description":"Metric Data type. Its enumerated values could be expanded over time. If an unknown value is encountered, treat it as STRING for compatibility.",
            "enum":[
                "NUMBER",
                "STRING"
            ],
            "example":"NUMBER"
        },
        "unitDisplayName":{
            "type":"string",
            "description":"Metric Unit Display Name",
            "example":"MB"
        }
    }
}

Nested Schema : self

Type: object

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        }
    ]
}

Examples

Select an example Response 1 Response (request with include=metrics)

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top