Get basic or detailed queue information by queue name (POST)

Description

URL

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

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

Description

Gets basic or detailed information for queues with the specified queue names.

HTTP Method

POST

Parameters

Name

Description

names

Mandatory. Name of the queue for which to retrieve information. To specify multiple queue names, separate with a comma(,). For example: normal,priority.

Use the keyword all to retrieve information for all queues in the cluster.

Request

Request-Method

POST

Request-URI

/platform/ws/queues/getbasicinfo

/platform/ws/queues/getfullinfo

Request-Header

Name

Value

Accept

application/xml or application/json

Message-body

names=%s

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 were found.
  • 500 Internal Server Error: Exception occurred.

Response-Header

Name

Value

Content-Type

application/xml or application/json

Message-body

Success Message for getfullinfo

If successful, returns detailed information about queues.

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

 
<queues total="%s">
  <atom:link href="self" rel="%s"/>
   <queue>
     <queueDescription>%s</queueDescription>
     <queueName>%s</queueName>
     <priority>%s</priority>
     <nice>%s</nice>
     <maxNumJobSlots>%s</maxNumJobSlots>
     <jlPerUser>%s</jlPerUser>
     <jlPerProcessor>%s</jlPerProcessor>
     <jlPerHost>%s</jlPerHost>
     <numJob>%s</numJob>
     <numPend>%s</numPend>
     <numRun>%s</numRun>
     <numSsusp>%s</numSsusp>
     <numUsusp>%s</numUsusp>
     <numReserve>%s</numReserve>
     <acceptInterval>%s</acceptInterval>
     <users>%s</users>
     <hosts>%s</hosts>
     <status>%s</status>
     <schedulingParameter>
       <loadSchedThreshold>
          <load name="swp" value="%s"/>
          <load name="it" value="%s"/>
          <load name="pg" value="%s"/>
          <load name="ls" value="%s"/>
          <load name="r1m" value="%s"/>
          <load name="r15s" value="%s"/>
          <load name="mem" value="%s"/>
          <load name="tmp" value="%s"/>
          <load name="ut" value="%s"/>
          <load name="r15m" value="%s"/>
          <load name="io" value="%s"/>
      </loadSchedThreshold>
      <loadStopThreshold>
          <load name="swp" value="%s"/>
          <load name="it" value="%s"/>
          <load name="pg" value="%s"/>
          <load name="ls" value="%s"/>
          <load name="r1m" value="%s"/>
          <load name="r15s" value="%s"/>
          <load name="mem" value="%s"/>
          <load name="tmp" value="%s"/>
          <load name="ut" value="%s"/>
          <load name="r15m" value="%s"/>
          <load name="io" value="%s"/>
      </loadStopThreshold>
     </schedulingParameter>
     <optionalAttributes>
          <attribute name="schedulingPolicies" value="%s"/>
          <attribute name="defaultQueueIndication" value="%s"/>
          <attribute name="hostSpecification" value="%s"/>
     </optionalAttributes>
   </queue>
</queues>
  Success Message for getbasicinfo

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 queue information for queues night and priority

# Request
POST /platform/ws/queues/getbasicinfo HTTP/1.1
Host: www.example.org
Authorization: Basic d2VsaXU6bGV0bWVpbg==
names=night,priority

# Response
200 Successful
Content-Type: application/xml;
<queues total="2">
     <pseudoQueue>
     <atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues/night"/>
      ...
    </pseudoQueue>
    <pseudoQueue>
      <atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues/priority"/>
      ...
    </pseudoQueue>
</queues>

Example: Get detailed information for queues normal and idle

# Request
POST /platform/ws/queues/getfullinfo HTTP/1.1
Host: www.example.org
Authorization: Basic d2VsaXU6bGV0bWVpbg==
names=normal,idle

# Response
200 Successful
Content-Type: application/xml;
<queues total = "2" >
     <queue>
     <atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues/idle"/>
      ...
    </queue>
    <queue>
      <atom:link href="self" rel="http://hostA.example.com:8080/platform/ws/queues/normal"/>
      ...
    </queue>