REST API for Oracle Enterprise Manager

Get latest values for the metrics in the group

get

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

Get the latest collected values from EM repository for the metrics in the target's metric group. For a metric group having no keys, a single row of data could be returned. For a metric group having keys, multiple rows of data could be returned.

Request

Path Parameters

metricGroupName(required): string
Metric Group Name
Example:
```
Filesystems
```
targetId(required): string
Target ID (.i.e, Target GUID)
Example:
```
CF99A10F233254B78ED96ED1B5C15140
```

Query Parameters

key_<name>: string
Optional parameter. When the metric has associated keys, query parameter having name of the form key_<name> can be used to filter for specific keys
Example:
```
key_mountPoint=/scratch&key_mountPoint=/
```
limit: integer(int32)

Minimum Value: 1

Maximum Value: 500

Limits the number of items returned in current call. Use the self/previous/next links from the response to fetch additional items.

Default Value: 50
metricName: string
Maximum Length: 64

Optional parameter, name of the metric.
Example:
```
size
```
page: string
Identifies the set of items to be fetched; "href" element from "links" list of the response provides encoded value for this parameter. "href" element value should be used "as is" for fetching respective set of items.
Example:
```
MQ%3D%3D
```
sort: string
Maximum Length: 256

Sort the results by one or more key columns. Column order should be specified as <key_column>:<sortDirection>. 'key_column' should be a valid key column for the metric in the query. 'sortDirection' can be 'ASC' (i.e., ascending order) or 'DESC' (i.e., descending order), and it defaults to 'ASC' if not specified. To sort over multiple columns, provide order for multiple columns separated by comma (i.e., ',').
Example:
```
mountPoint:DESC
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : MetricGroupLatestData

Type: object

Latest collected data for the metrics in the target's metric group.

Show Source

count(required): integer

Number of rows present in returned items list

Example: 2
items(required): array items

Provides rows of metric data corresponding to latest upload for the metric group. For a metric group having no keys, single row of data could be returned. For a metric group having key(s), multiple rows of data could be returned. Rows are identified by key values. When no data exists, it would be empty.
links(required): object links

Navigations links. Use previous and next links for paginating, when more data exists.
metricGroupName(required): string

Maximum Length: 64

Metric group

Example: Filesystems
targetId(required): string

Maximum Length: 32

target's ID

Example: CF99A10F233254B78ED96ED1B5C15140
targetName(required): string

Maximum Length: 256

target name

Example: myhost.mydomain.com
targetTypeName(required): string

Maximum Length: 64

target type

Example: host
timeCollected(required): string

date time format - yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Example: 2021-08-26T21:35:55.000Z

{
    "type":"object",
    "description":"Latest collected data for the metrics in the target's metric group.",
    "required":[
        "targetName",
        "targetTypeName",
        "targetId",
        "metricGroupName",
        "timeCollected",
        "count",
        "items",
        "links"
    ],
    "properties":{
        "targetName":{
            "type":"string",
            "maxLength":256,
            "description":"target name",
            "example":"myhost.mydomain.com"
        },
        "targetTypeName":{
            "type":"string",
            "maxLength":64,
            "description":"target type",
            "example":"host"
        },
        "targetId":{
            "type":"string",
            "maxLength":32,
            "description":"target's ID",
            "example":"CF99A10F233254B78ED96ED1B5C15140"
        },
        "metricGroupName":{
            "type":"string",
            "maxLength":64,
            "description":"Metric group",
            "example":"Filesystems"
        },
        "timeCollected":{
            "type":"string",
            "description":"date time format - yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "example":"2021-08-26T21:35:55.000Z"
        },
        "count":{
            "type":"integer",
            "description":"Number of rows present in returned items list",
            "example":2
        },
        "items":{
            "description":"Provides rows of metric data corresponding to latest upload for the metric group. For a metric group having no keys, single row of data could be returned. For a metric group having key(s), multiple rows of data could be returned. Rows are identified by key values. When no data exists, it would be empty.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetricRowData"
            },
            "example":[
                {
                    "mountPoint":"/",
                    "available":29004.7,
                    "fileSystem":"/dev/vda1",
                    "pctAvailable":60.82,
                    "size":50267.62
                },
                {
                    "mountPoint":"/scratch",
                    "available":65508.38,
                    "fileSystem":"/dev/vdb",
                    "pctAvailable":28.55,
                    "size":241776.06
                }
            ]
        },
        "links":{
            "type":"object",
            "description":"Navigations links. Use previous and next links for paginating, when more data exists.",
            "properties":{
                "previous":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                },
                "self":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                },
                "next":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                }
            },
            "example":{
                "self":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MQ%3D%3D"
                },
                "next":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=Mg%3D%3D"
                },
                "previous":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MA%3D%3D"
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Provides rows of metric data corresponding to latest upload for the metric group. For a metric group having no keys, single row of data could be returned. For a metric group having key(s), multiple rows of data could be returned. Rows are identified by key values. When no data exists, it would be empty.

Show Source

Array of: object MetricRowData

Additional Properties Allowed: additionalProperties

Represents one row of metric data corresponding to the metric group. Row is a comma separated name/value pairs, where name identifies metric or key, and value is numeric or string type.

{
    "description":"Provides rows of metric data corresponding to latest upload for the metric group. For a metric group having no keys, single row of data could be returned. For a metric group having key(s), multiple rows of data could be returned. Rows are identified by key values. When no data exists, it would be empty.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MetricRowData"
    },
    "example":[
        {
            "mountPoint":"/",
            "available":29004.7,
            "fileSystem":"/dev/vda1",
            "pctAvailable":60.82,
            "size":50267.62
        },
        {
            "mountPoint":"/scratch",
            "available":65508.38,
            "fileSystem":"/dev/vdb",
            "pctAvailable":28.55,
            "size":241776.06
        }
    ]
}

Example:

[
    {
        "mountPoint":"/",
        "available":29004.7,
        "fileSystem":"/dev/vda1",
        "pctAvailable":60.82,
        "size":50267.62
    },
    {
        "mountPoint":"/scratch",
        "available":65508.38,
        "fileSystem":"/dev/vdb",
        "pctAvailable":28.55,
        "size":241776.06
    }
]

Nested Schema : links

Type: object

Navigations links. Use previous and next links for paginating, when more data exists.

Show Source

next: object next
previous: object previous
self: object self

{
    "type":"object",
    "description":"Navigations links. Use previous and next links for paginating, when more data exists.",
    "properties":{
        "previous":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        },
        "self":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        },
        "next":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        }
    },
    "example":{
        "self":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MQ%3D%3D"
        },
        "next":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=Mg%3D%3D"
        },
        "previous":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MA%3D%3D"
        }
    }
}

Example:

{
    "self":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MQ%3D%3D"
    },
    "next":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=Mg%3D%3D"
    },
    "previous":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MA%3D%3D"
    }
}

Nested Schema : MetricRowData

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"Represents one row of metric data corresponding to the metric group. Row is a comma separated name/value pairs, where name identifies metric or key, and value is numeric or string type.",
    "example":{
        "mountPoint":"/",
        "available":29004.7,
        "fileSystem":"/dev/vda1",
        "pctAvailable":60.82,
        "size":50267.62
    },
    "additionalProperties":{
        "type":"string"
    }
}

Represents one row of metric data corresponding to the metric group. Row is a comma separated name/value pairs, where name identifies metric or key, and value is numeric or string type.

Example:

{
    "mountPoint":"/",
    "available":29004.7,
    "fileSystem":"/dev/vda1",
    "pctAvailable":60.82,
    "size":50267.62
}

Nested Schema : next

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 : previous

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 : 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"
        }
    }
}

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

{
    "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

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.

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.

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.

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"
        }
    }
}