Get Install Status of Server Roles
get
/api/broker/Servers/readInstallStatus
Gets the install status of server roles and subroles for servers matching the specified parameters. If no parameters are specified, all servers are returned.
Request
Query Parameters
-
limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.Example:
100
-
start: integer(int32)
The page of results to start from. This parameter is ignored if you do not also set the limit parameter.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
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
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 : brokerServersReadInstallStatus
Type:
Show Source
object
-
ServerID: integer
The server ID.Example:
1
-
status: string
The server role status that follows the format RoleStatus::RoleSetName::RoleName::SubRoleName::RoleStatusText.Example:
6::Assure1::Cluster::Master::,,6::Assure1::Collection::Core::
-
total: integer
The total number of installed server roles mentioned in the status property.Example:
2
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.