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

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

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

Gets basic or detailed information for hosts with the specified host names, or for hosts that are members of the specified host groups.

POST

Description

names

Mandatory. Name of the host for which to retrieve information, or name of the host group for which to retrieve host information. To specify multiple host names or host groups, separate with a comma(,). For example: hostA,hostB.

Use the keyword all to retrieve detailed information for all hosts in the cluster.

/platform/ws/hosts/getbasicinfo

/platform/ws/hosts/getfullinfo

names=%s

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

If successful, returns detailed information about hosts.

For additional information, refer to the schema file ./schemas/hosts/hosts_detailed.xsd and ./schemas/hosts/hosts_schema.xsd.

<hosts total="%s">
  <atom:link href="self" rel="%s"/>
  <host>
    <hostName>%s</hostName>
    <serverType>%s</serverType>
    <staticResources builtin="true" type="string" value="%s" name="hostType"/>
    <staticResources builtin="true" type="string" value="%s" name="hostModel"/>
    <staticResources builtin="true" type="float" value="%s" name="cpuFactor"/>
    <staticResources builtin="true" type="int" value="2" name="nCpus"/>
    <staticResources builtin="true" type="int" value="%s" name="nDisks"/>
    <staticResources builtin="true" type="int" value="%s" name="maxMem"/>
    <staticResources builtin="true" type="int" value="%s" name="maxSwap"/>
    <staticResources builtin="true" type="int" value="%s" name="maxTmp"/>
    <staticResources builtin="true" type="int" value="%s" name="rexPriority"/>
    <staticResources builtin="true" type="int" value="%s" name="nprocs"/>
    <staticResources builtin="true" type="int" value="%s" name="ncores"/>
    <staticResources builtin="true" type="int" value="%s" name="nthreads"/>
    <staticResources builtin="false" type="boolean" value="%s" name="nt"/>
    <staticResources builtin="false" type="boolean" value="%s" name="mg"/>
    <baseStatus>%s</baseStatus>
    <batchStatus>%s</batchStatus>
    <numSlots>%s</numSlots>
    <jlPerUser>%s</jlPerUser>    
    <numJobs>%s</numJobs>
    <numRun>%s</numRun>
    <numSsusp>%s</numSsusp>
    <numUsusp>%s</numUsusp>
    <numReserved>%s</numReserved>
    <dispatchWindows>%s</dispatchWindows>
    <runWindows>%s</runWindows>
    <numindex>%s</numindex>
    <realLoad>
      <load builtin="true" value="%s" name="r15s"/>
      <load builtin="true" value="%s" name="r1m"/>
      <load builtin="true" value="%s" name="r15m"/>
      <load builtin="true" value="%s" name="ut"/>
      <load builtin="true" value="%s" name="pg"/>
      <load builtin="true" value="%s" name="io"/>
      <load builtin="true" value="%s" name="ls"/>
      <load builtin="true" value="%s" name="it"/>
      <load builtin="true" value="%s" name="tmp"/>
      <load builtin="true" value="%s" name="swp"/>
      <load builtin="true" value="%s" name="mem"/>
    </realLoad>
    

<currentLoadUsedForScheduling>
      <total>
        <load builtin="true" value="%s" name="r15s"/>
        <load builtin="true" value="%s" name="r1m"/>
        <load builtin="true" value="%s" name="r15m"/>
        <load builtin="true" value="%s" name="ut"/>
        <load builtin="true" value="%s" name="pg"/>
        <load builtin="true" value="%s" name="io"/>
        <load builtin="true" value="%s" name="ls"/>
        <load builtin="true" value="%s" name="it"/>
        <load builtin="true" value="%s" name="tmp"/>
        <load builtin="true" value="%s" name="swp"/>
        <load builtin="true" value="%s" name="mem"/>
      </total>
      <reserve>
        <load builtin="true" value="%s" name="r15s"/>
        <load builtin="true" value="%s" name="r1m"/>
        <load builtin="true" value="%s" name="r15m"/>
        <load builtin="true" value="%s" name="ut"/>
        <load builtin="true" value="%s" name="pg"/>
        <load builtin="true" value="%s" name="io"/>
        <load builtin="true" value="%s" name="ls"/>
        <load builtin="true" value="%s" name="it"/>
        <load builtin="true" value="%s" name="tmp"/>
        <load builtin="true" value="%s" name="swp"/>
        <load builtin="true" value="%s" name="mem"/>
      </reserve>
    </currentLoadUsedForScheduling>
    <loadThreshHoldUsedForScheduling>
      <loadSched>
        <load builtin="true" value="%s" name="r15s"/>
        <load builtin="true" value="%s" name="r1m"/>
        <load builtin="true" value="%s" name="r15m"/>
        <load builtin="true" value="%s" name="ut"/>
        <load builtin="true" value="%s" name="pg"/>
        <load builtin="true" value="%s" name="io"/>
        <load builtin="true" value="%s" name="ls"/>
        <load builtin="true" value="%s" name="it"/>
        <load builtin="true" value="%s" name="tmp"/>
        <load builtin="true" value="%s" name="swp"/>
        <load builtin="true" value="%s" name="mem"/>
      </loadSched>
      <loadStop>
        <load builtin="true" value="%s" name="r15s"/>
        <load builtin="true" value="%s" name="r1m"/>
        <load builtin="true" value="%s" name="r15m"/>
        <load builtin="true" value="%s" name="ut"/>
        <load builtin="true" value="%s" name="pg"/>
        <load builtin="true" value="%s" name="io"/>
        <load builtin="true" value="%s" name="ls"/>
        <load builtin="true" value="%s" name="it"/>
        <load builtin="true" value="%s" name="tmp"/>
        <load builtin="true" value="%s" name="swp"/>
        <load builtin="true" value="%s" name="mem"/>
      </loadStop>
    </loadThreshHoldUsedForScheduling>
  </host>
  <host>
    ...
  </host>
</hosts>

If successful, returns basic information about hosts.

For additional information, refer to the schema file ./schemas/hosts/pseudohost.xsd and ./schemas/hosts/hosts_schema.xsd.

<hosts total="%s">
  <atom:link href="self" rel="%s"/>
  <pseudoHost>
    <hostName>%s</hostName>
    <serverType>%s</serverType>
    <baseStatus>%s</baseStatus>
    <batchStatus>%s</batchStatus>
    <numSlots>%s</numSlots>
    <jlPerUser>%s</jlPerUser>
    <numJobs>%s</numJobs>
    <numRun>%s</numRun>
    <numSsusp>%s</numSsusp>
    <numUsusp>%s</numUsusp>
    <numReserved>%s</numReserved>
    <staticResources builtin="true" type="string" value="%s" name="hostType"/>
    <staticResources builtin="true" type="string" value="%s" name="hostModel"/>
    <staticResources builtin="true" type="float" value="%s" name="cpuFactor"/>
    <staticResources builtin="true" type="int" value="%s" name="nCpus"/>
    <staticResources builtin="true" type="int" value="%s" name="nDisks"/>
    <staticResources builtin="true" type="int" value="%s" name="maxMem"/>
    <staticResources builtin="true" type="int" value="%s" name="maxSwap"/>
    <staticResources builtin="true" type="int" value="%s" name="maxTmp"/>
    <staticResources builtin="true" type="int" value="%s" name="rexPriority"/>
    <staticResources builtin="true" type="int" value="%s" name="nprocs"/>
    <staticResources builtin="true" type="int" value="%s" name="ncores"/>
    <staticResources builtin="true" type="int" value="%s" name="nthreads"/>
    <staticResources builtin="false" type="boolean" value="%s" name="nt"/>
    <staticResources builtin="false" type="boolean" value="%s" name="mg"/>
  </pseudoHost>
  <pseudoHost>
    ...
  </pseudoHost>
</hosts>

If not successful, returns an error message.

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

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