Get local cluster information

Edit online

Description

URL scheme://domain:port/platform/ws/clusters/local
Description

The logged on user must be have the cluster administrator role to use this API.

Gets local cluster information such as cluster name, management host name and status, LSF version and primary LSF administrator.
HTTP Method GET
Parameters None

Request

Method GET
Request-URI /platform/ws/clusters/local
Request-Header Name Value
Accept application/xml, or application/json
Message-Body empty

Response

Response Code
  • 200 Successful: Request was successful.
  • 403 Forbidden: Access is restricted by role-based access control permissions.
  • 404 Not Found: Unable to contact the local cluster.
  • 500 Internal Server Error: Exception occurred.
Response-Header Name Value
Content-Type application/xml or application/json
Message Body Success Message

If successful, returns cluster information.

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pseudoCluster>
    <status>ok</status>
    <admins>jsmith lsfadmin</admins>
    <clusterName>lsf10.main</clusterName>
   <hostModel>UNKNOWN_AUTO_DETECT Intel_EM64T</hostModel>
    <hostType>UNKNOWN_AUTO_DETECT X86_64</hostType>
    <lsfVersion>10.1.0.8</lsfVersion>
    <masterHost>lsfmanagementhost1</masterHost>
</pseudoCluster>
Failure Message

If not successful, returns an error message.

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

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

Example: View information about your cluster

# Request
GET /platform/ws/clusters/local HTTP/1.1
Host: www.example.org
Authorization: Basic d2VsaXU6bGV0bWVpbg==
# Response
200 Successful
Content-Type: application/xml;
<cluster>
<atom:link rel="self" href="http://www.example.org/platfom/ws/clusters/local"/>   
<clusterName>cluster_test</clusterName>
<status>ok</status>   
<masterHost>lsflinux3</masterHost>   
<admins>user1 user20</admins>   
<lsfVersion>9.1.0.0</lsfVersion>   
</cluster>