MEF Performance Monitoring (Mef Lso Legato Performance Monitoring) is one of 95 APIs that MEF publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
25 operations
across 17 paths,
organized into 5 resource areas,
and defines 62 schemas.
It is described by OpenAPI 3.0.1, at version 5.0.0.
Requests are made against a single base URL, https://{serverBase}/mefApi/legato/performanceMonitoring/v5/.
The identity and technical contract details declared by the specification.
AttachmentURL
object
The URL pointing to an Attachment for download.
2 properties
1 required
CancelPerformanceJob
Request for cancellation of an existing Performance Job.
CancelPerformanceJob_Create
object
Request for cancellation of an existing Performance Job.
1 property
1 required
EntityRef
object
Reference to Entity.
4 properties
3 required
Error
object
Standard Class used to describe API response error Not intended to be used directly. The code in the HTTP header is used as a discriminator for the type of err…
3 properties
1 required
Error400
'Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)'
Error400Code
string
One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a requi…
Error401
'Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)'
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided - invalidCredentials: Provided credentials are invalid or expired.
Error403
Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231section-6.5.3)
Error403Code
string
This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access deni…
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
Error409
Conflict (https://datatracker.ietf.org/doc/html/rfc7231section-6.5.8)
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
Error422Code
string
One of the following error codes: - missingProperty: The property that was expected is not present in the payload - invalidValue: The property has an incorrect…
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
Error501
Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231section-6.6.2)
EventSubscription
object
This resource is used to respond to notification subscriptions.
3 properties
2 required
EventSubscriptionInput
object
This class is used to register for Notifications.
2 properties
1 required
JobType
string
The type of a Job. Proactive jobs are carried on continuously to permit timely reporting of fault or performance status. On-demand jobs are actions that are in…
MeasurementTime
object
Timeframe boundary for collected data. Provide measurementStartDate and measurementEndDate or measurementStartDate and measurementInterval.
3 properties
1 required
ModifyPerformanceJob
Request for modification of an existing Performance Job.
ModifyPerformanceJob_Create
object
Request for modification of an existing Performance Job.
7 properties
1 required
MonitoredObjectRef
object
Defines the reference to object which is a subject of performance monitoring.
OutputFormat
string
List of possible output formats for the Report.
PerformanceJob
A Performance Monitoring Job specifies the performance monitoring objectives specific to each subject of monitoring which could be a service, an ordered pair (…
PerformanceJobComplexQuery_Create
object
Performance Job Complex Query entity is used to perform searches on Performance Job entities, including clauses based on ScheduleDefinition and ServiceSpecific…
9 properties
PerformanceJobProcessStateType
string
The state of the process related to the Performance Job. | state | Mplify 133.1 name | Description | | -------------- | ----------------- | -------------------…
PerformanceJobRef
object
A reference to a Performance Job resource.
3 properties
2 required
PerformanceJobStateType
string
The state of the Performance Monitoring Job. | state | Mplify 133.1 name | Description | | ---------------------- | ------------------------ | ----------------…
PerformanceJob_Create
object
A Performance Monitoring Job specifies the performance monitoring objectives specific to each subject of monitoring which could be a service, an ordered pair (…
7 properties
3 required
PerformanceProfile
A Performance Monitoring Profile specifies the common performance configuration that can be reused by multiple Performance Jobs.
PerformanceProfileLifecycleStatusType
string
Possible values for the Performance Profile Status. | State | Mplify 133.1 name | Description | | -------------- | ------------------ | -----------------------…
PerformanceProfileRef
object
A reference to a Performance Profile resource.
3 properties
2 required
PerformanceProfileRefOrValue
object
Defines the reference to Performance Monitoring Profile or defines values from PerformanceProfile type.
PerformanceProfileRefOrValue_Query
object
Defines the reference to Performance Monitoring Profile or defines values from PerformanceProfile type.
PerformanceProfileValue
object
The setting of the attributes defined by the PerformanceProfile class when the Performance Job does not have a reference to the Performance Profile.
8 properties
7 required
PerformanceProfileValue_Modify
object
The setting of the attributes defined by the PerformanceProfile class when the Performance Job does not have a reference to the Performance Profile. This class…
6 properties
PerformanceProfileValue_Query
object
The setting of the attributes defined by the PerformanceProfile class when the Performance Job does not have a reference to the Performance Profile.
8 properties
1 required
PerformanceProfile_Create
object
A Performance Monitoring Profile specifies the common performance configuration that can be reused by multiple Performance Jobs.
9 properties
7 required
PerformanceProfile_Update
object
A Performance Monitoring Profile specifies the common performance configuration that can be reused by multiple Performance Jobs.
8 properties
PerformanceReport
The execution of PM Job results in Performance Measurement collections that provide Buyer/Client with performance objective results.
PerformanceReportComplexQuery_Create
object
Performance Report Complex Query entity is used to perform searches on Performance Report entities, including clauses based on ServiceSpecificConfiguration.
13 properties
PerformanceReportRef
object
A reference to a Performance Report resource.
3 properties
2 required
PerformanceReportStateType
string
Possible values for the state of a Performance Report. | State | Mplify 133.1 name | Description | | -------------- | ----------------- | ---------------------…
PerformanceReport_Create
object
The creation of the PM Report enables the collection of PM results, which are stored in the PM database within the Seller/Server system.
7 properties
6 required
PerformanceReport_Find
object
This class represents a single list item for the response of the listPerformanceReport operation.
11 properties
10 required
PmTrackingRecord
object
Tracking Records allow the tracking of modifications of Performance Job, Profile, or Report.
6 properties
3 required
RecurringSchedule
object
A definition of recurring schedule to run a job based on the Cron utility in Linux-like systems. It defines how the job should periodically run at specified ti…
6 properties
RelatedObjectRef
object
Reference to the Performance Job, Profile, or Report for which the Tracking Record was created.
ReportContentItem
object
Single item of the results in case result format was set to payload. Each item contains the timeframe of the collected data and a list of values captured in th…
2 properties
2 required
ReportContentPerMonitoredObject
object
Result of the performance monitoring for a specific monitored object.
2 properties
2 required
ReportingTimeframe
object
Specifies the date range between which data points will be included in the report.
2 properties
ResultFormat
string
List of possible result formats that define how Seller/Server will deliver a Report to the Buyer/Client.
ScheduleDefinition
object
The schedule definition for running jobs.
4 properties
ServiceFromToRef
object
Reference to Service From and Service To endpoints.
3 properties
3 required
ServiceRef
object
Reference to a Service.
3 properties
2 required
ServiceSpecificConfiguration
object
ServiceSpecificConfiguration is used as an extension point for Mplify -specific service performance monitoring configuration. The @type attribute is used as a…
1 property
1 required
ServiceSpecificResult
object
ServiceSpecificResult is used as an extension point for Mplify -specific service performance monitoring results. The @type attribute is used as a discriminator.
1 property
1 required
TerminationError
object
This indicates an error that caused a PM Job or PM Report to be terminated. The code and propertyPath should be used like in Error422.
3 properties
TimeDuration
object
This class is used to describe durations expressed as a 2-tuple, (value, units). The units from nanoseconds to years.
2 properties
2 required
TimeDurationUnits
string
The unit of measure in the duration. For example, if an interval is 2ms, this element is MS.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.