Get basic queue information

Edit online

Description

URL

scheme://domain:port/platform/ws/queues

Description

By default, gets basic information for all queues in the cluster.

HTTP Method

GET

Parameters

 Name Description
 

names

Optional.

Gets basic information about the specified queues.

When this parameter is not specified or empty, gets basic information for all queues in the cluster.

Use the keyword all to get basic information for all queues in the cluster.

Separate multiple queue names with a comma(,). For example: normal,night,priority.

status

Optional. Gets basic information about all queues that are in the specified state.

When this parameter is not specified or empty, gets basic information for queues in all states.

Use the keyword all to get basic information about all queues in all states.

Queue state can be changed by an LSF administrator or root. Queues can also be activated and inactivated by run windows and dispatch windows.

Valid values:

  • all: Gets basic information about all queues in all states.

  • open: The queue accepts new jobs. Displays the results of both openactive, openinactive.

  • openactive: The queue accepts and starts new jobs—normal processing.
  • openinactive: The queue accepts new jobs but jobs cannot be started on hosts because the queue has been inactivated.

  • closed: The queue does not accept new jobs. Displays the results of closedactive, closedinactive.

  • closedactive: The queue does not accept new jobs, but continues to start jobs — draining.
  • closedinactive: The queue does not accept new jobs and does not start jobs—all activity is stopped because the queue has been inactivated.

  • active: Jobs in the queue can be started on available hosts. Displays the results of openactive, closedactive.

  • inactive: Jobs in the queue cannot be started because the queue has been inactivated. Displays the results of openinactive, closedinactive.

Request

Request

Request Information

Notes

Method

GET

  

Request-URI

http://<hostname>:<port>/platform/ws/queues

OR

http://<hostname>:<port>/platform/ws/queues?names=%s&status=%s

Parameters: names, status.

Request-Header

Name

Value

  

Accept

Application/xml or application/json

Message-Body

empty

  

Response

Response Code

  • 200 Successful: Request was successful.
  • 403 Forbidden: Access restricted by role-based access control permissions.
  • 404 Not Found: No queues that match the specified criteria found.
  • 500 Internal Server Error: Exception occurred

Response-Header

Name

Value

Content-Type

Application/xml or application/json

Message-body

 Success Message

If successful, returns basic information about queues.

For additional information, refer to the schema file ./schemas/queues/pseudoqueue.xsd and ./schemas/queues/queues_schema.xsd.

<queues total="%s">
  <atom:link href="self" rel="%s"/>
    <pseudoQueue>
      <queueName>%s</queueName>
      <priority>%s</priority>
      <maxNumJobSlots>%s</maxNumJobSlots>
      <jlPerUser>%s</jlPerUser>
      <jlPerProcessor>%s</jlPerProcessor>
      <jlPerHost>%s</jlPerHost>
      <numJob>%s</numJob>
      <numPend>%s</numPend>
      <numRun>%s</numRun>
      <numSsusp>%s</numSsusp>
      <status>%s</status>
    </pseudoQueue>
    <pseudoQueue>
      ...
    </pseudoQueue>
</queues>
Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/queues/error.xsd.

<error>
  <message>
     %s
  </message>
</error>

Example: Get basic information about all queues in the cluster

# Request
GET /platform/ws/queues HTTP/1.1
Host: www.example.org
Authorization: Basic d2VsaXU6bGV0bWVpbg==
# Response
200 Successful
Content-Type: application/xml;
<queues  total = "9">
<atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues"/>
  <pseudoQueue>
   ....
  </pseudoQueue>
</ queues >

Example: Get basic information about the queues night and idle

<queues total="2">
  <atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues?names=night,idle"/>
    <pseudoQueue>
      <queueName>night</queueName>
      <priority>40</priority>
      <maxNumJobSlots>-1</maxNumJobSlots>
      <jlPerUser>-1</jlPerUser>
      <jlPerProcessor>-1</jlPerProcessor>
      <jlPerHost>-1</jlPerHost>
      <numJob>0</numJob>
      <numPend>0</numPend>
      <numRun>0</numRun>
      <numSsusp>0</numSsusp>
      <status>openActive</status>
    </pseudoQueue>
    <pseudoQueue>
      <queueName>idle</queueName>
      <priority>20</priority>
      <maxNumJobSlots>-1</maxNumJobSlots>
      <jlPerUser>-1</jlPerUser>
      <jlPerProcessor>-1</jlPerProcessor>
      <jlPerHost>-1</jlPerHost>
      <numJob>0</numJob>
      <numPend>0</numPend>
      <numRun>0</numRun>
      <numSsusp>0</numSsusp>
      <status>openActive</status>
    </pseudoQueue>
</queues>