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
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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 Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : brokerServersReadInstallStatus
Type: object
Show Source
  • The server ID.
    Example: 1
  • The server role status that follows the format RoleStatus::RoleSetName::RoleName::SubRoleName::RoleStatusText.
    Example: 6::Assure1::Cluster::Master::,,6::Assure1::Collection::Core::
  • The total number of installed server roles mentioned in the status property.
    Example: 2

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top