Jump to

• Request
• Response

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, the statuses for all server roles and subroles are returned.

Request

Query Parameters

• limit: integer(int32)
  The number of records to limit results by.

  Example:

  100

• 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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/brokerServersReadInstallStatus"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/brokerServersReadInstallStatus"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object brokerServersReadInstallStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/brokerServersReadInstallStatus"
    }
}

Nested Schema : brokerServersReadInstallStatus

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "ServerID":{
            "description":"The server ID.",
            "type":"integer",
            "example":"1"
        },
        "status":{
            "description":"The server role status that follows the format \"RoleStatus::RoleSetName::RoleName::SubRoleName::RoleStatusText\".",
            "type":"string",
            "example":"6::Assure1::Cluster::Master::,,6::Assure1::Collection::Core::"
        },
        "total":{
            "description":"The total number of installed server roles mentioned in the status property.",
            "type":"integer",
            "example":"2"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top