Get Details of All Failover Service States
get
/api/broker/FailoverStates
Gets the details of all the services across the Unified Assurance installation that are configured in either a Primary/Backup failover state or in a Cluster state. You can narrow down the results further by using the query parameters.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
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
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : brokerFailoverStatesRead
Type:
Show Source
object
-
ClusterID: integer
The cluster ID specified for failover.Example:
2
-
FailoverType: string
The failover type.Example:
Cluster
-
Grouping: string
Logical GroupingExample:
StandardThreshold
-
HostName: string
Host Name or Server URL where the services are runningExample:
test.pgbox.com
-
id: string
A general unique id for the objectExample:
652b5238333f6
-
PackageName: string
The package name.Example:
coreProcessing-app
-
ProgName: string
The program name.Example:
bin/MetricEngine
-
ServiceID: integer
The service ID.Example:
321
-
ServiceName: string
The service name.Example:
Metric Engine
-
State: string
Indicator of the failover service stateExample:
Running
-
StateIcon: string
Icon for representing the state of the servicesExample:
OrbGreenUp.png
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