Get a Metric Threshold Group
get
/api/metric/ThresholdGroups/{id}
Gets the metric threshold group that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The ID of the threshold group to get.Example:
1
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 : type
Type:
Show Source
object
-
data: array
data
The metric threshold group that matches the specified ID.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The metric threshold group that matches the specified ID.
Show Source
Nested Schema : metricThresholdGroupsRead
Type:
Show Source
object
-
MeasurementList: string
Measurement ListExample:
metrictype_Latency <br>metrictype_Packet_Loss <br>metrictype_Ping_Jitter <br>metrictype_Ping_Jitter_Utilization
-
MetricTypeNameList: string
Metric TypeName ListExample:
Latency <br>Packet Loss <br>Ping Jitter <br>Ping Jitter Utilization
-
ThresholdCount: integer
Threshold CountExample:
5
-
ThresholdGroupID: integer
Threshold Group IDExample:
1
-
ThresholdGroupName: string
Threshold Group NameExample:
Default Ping
-
Thresholds: array
Thresholds
Threshold IDs
Nested Schema : items
Type:
Show Source
object
-
Measurement: string
MeasurementExample:
metrictype_Latency
-
MetricTypeName: string
Metric Type NameExample:
Latency
-
ThresholdID: integer
Threshold IDExample:
1
-
ThresholdName: string
Threshold NameExample:
Device Down
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