Get a Summary of Availability Information for an Instance
get
/api/metric/AvailabilityData/readSummary
Gets a summary in pie chart format of availability information for the specified instance.
Request
Query Parameters
-
DeviceName(required): string
The device name corresponding to Devices.DeviceName.Example:
router.example.com
-
DeviceZoneName(required): string
The device zone name.Example:
Oracle Lab - Network Equipment
-
InstanceName(required): string
The metric instance name corresponding to metricInstances.Example:
Device
-
MetricType(required): string
The metric Type name corresponding to MetricTypes.Example:
Latency
-
TimeRange(required): string
A shorthand string that encompasses StartTime and StopTime. Overwrites any value set for Start and StopTime. If no value is provided, the most recent 24 hour period is used.Example:
now-24h..now
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : metricAvailabilityDataReadSummary
Type:
Show Source
object
-
DeviceName: string
Device NameExample:
router.example.com
-
GraphData: array
GraphData
This holds 2 Type/Value objects. Type is Available and Unavailable. Value is percent of time available (0-100), and percent of time unavailable (0-100).
-
Maximum: integer
MaximumExample:
0
-
MetricID: integer
May be a single value or a comma-separated listExample:
642677
-
MetricInstanceName: string
Metric Instance NameExample:
Device
-
MetricTypeName: string
Metric Type NameExample:
Latency
-
Retention: string
The retention period the data is drawn from.Example:
raw
-
StartTime: string
Epoch time stringExample:
1695201840
-
StopTime: string
Epoch time stringExample:
1695288240
Nested Schema : GraphData
Type:
array
This holds 2 Type/Value objects. Type is Available and Unavailable. Value is percent of time available (0-100), and percent of time unavailable (0-100).
Show Source
Example:
[
{
"Type":"Available",
"Value":"100"
},
{
"Type":"Unavailable",
"Value":"0"
}
]
Nested Schema : items
Type:
Show Source
object
-
Type: string
TypeExample:
Available
-
Value: integer
ValueExample:
100
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object