Balancer

Overview

Balancer requests can be used to set and retrieve Balancer information using GET and PUT. POST and DELETE are not supported and sending a message of either of these types will result in a 501 Not Implemented error message. For more about these request types and their uses see the Request Formats and Responses documentation.

Requests and Responses

List of possible requests for Balancer.

Get Balancer Names

Gets all the Balancer names.

URL: http://hostname:portnumber/api/balancer?NamesOnly=true

Request Type: GET

Message Body: N/A

Response: JSON object containing all the Balancer names.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get Balancer Information

Gets the Balancer information for the Balancer names provided.

URL: http://hostname:portnumber/api/balancer?Info=true&Names=oneOrMoreBalancerNamesOR http://hostname:portnumber/api/balancer?Info=true&Name=oneBalancerName

Request Type: GET

Message Body: N/A

Response: JSON object containing all the Balancer information for the requested Balancer names.

Possible Errors:
  • 404 Not Found: Balancer name provided does not exist (can only occur if you use Name= )
  • 500 Internal Server Error: An exception occurred within the Deadline code.

Save Balancer Information

Saves the Balancer information provided.

URL: http://hostname:portnumber/api/balancer

Request Type: PUT

Message Body:
JSON object where the following keys are mandatory:
  • Command = saveinfo
  • BalancerInfo = JSON object containing all the Balancer information.

Response: “Success”

Possible Errors:
  • 400 Bad Request: Did not provide a Balancer Information JSON object
  • 500 Internal Server Error: An exception occurred within the Deadline code.

Get Balancer Settings

Gets the Balancer settings for the Balancer names provided.

URL: http://hostname:portnumber/api/balancer?Settings=true&Names=oneOrMoreBalancerNamesOR http://hostname:portnumber/api/balancer?Settings=true&Name=oneBalancerName

Request Type: GET

Message Body: N/A

Response: JSON object containing all the Balancer settings for the requested Balancer names.

Possible Errors:
  • 404 Not Found: Balancer name provided does not exist (can only occur if you use Name= )
  • 500 Internal Server Error: An exception occurred within the Deadline code.

Save Balancer Settings

Saves the Balancer settings provided.

URL: http://hostname:portnumber/api/balancer

Request Type: PUT

Message Body:
JSON object where the following keys are mandatory:
  • Command = savesettings
  • BalancerSettings = JSON object containing all the Balancer information.

Response: “Success”

Possible Errors:
  • 400 Bad Request: Did not provide a Balancer Information JSON object
  • 500 Internal Server Error: An exception occurred within the Deadline code.

Get Balancer InfoSettings

Gets the Balancer information and settings for the Balancer names provided.

URL: http://hostname:portnumber/api/balancer?Names=oneOrMoreBalancerNamesOR http://hostname:portnumber/api/balancer?Name=oneBalancerName

Request Type: GET

Message Body: N/A

Response: JSON object containing all the Balancer information and settings for the requested Balancer names.

Possible Errors:
  • 404 Not Found: Balancer name provided does not exist (can only occur if you use Name= )
  • 500 Internal Server Error: An exception occurred within the Deadline code.

Balancer Property Values

Values for some Balancer properties are represented by numbers. Those properties and their possible values are listed below.

Stat (BalancerStatus)
  • 0 = Unknown
  • 1 = Running
  • 2 = Offline
  • 4 = Stalled