Get parameters set for an abstracted configuration category(GET)

Edit online

Description

URL

scheme://domain:port/platform/ws/lsfconfig/{configId}/clusterparameters

scheme://domain:port/platform/ws/lsfconfig/{configId}/resources

scheme://domain:port/platform/ws/lsfconfig/{configId}/hosts

scheme://domain:port/platform/ws/lsfconfig/{configId}/hostgroups

scheme://domain:port/platform/ws/lsfconfig/{configId}/queues

scheme://domain:port/platform/ws/lsfconfig/{configId}/users

scheme://domain:port/platform/ws/lsfconfig/{configId}/usergroups

scheme://domain:port/platform/ws/lsfconfig/{configId}/resourcelimits

scheme://domain:port/platform/ws/lsfconfig/{configId}/resourcereservations
Description

Gets detailed information of an LSF configuration category from the database with the last modified time set in the response header. Each LSF configuration category has its own last modified time.

If the client has a copy of the LSF configuration category stored locally, you can send a conditional GET request with an If-Modified-Since header. If the LSF configuration category has not been modified since the last modified time known to the client, a 304 (Not Modified) response code is returned with no message body.

Note: Using last-modified-time only checks if the client has the latest LSF configuration data from the database. If LSF configuration files are modified outside of Platform Web Services, it is possible for the client to have the latest LSF configuration in the database, but this does not correctly reflect the actual LSF cluster. To ensure you have the latest LSF cluster configuration, re-load the LSF configuration with the API /platform/ws/lsfconfig/load.

If the client does not have a copy of the LSF configuration category stored locally, or to ensure the client has the most accurate LSF configuration details, send an unconditional GET request(Cache-Control: no-cache, and Pragma: no-cache set in the request header) to obtain a new representation of the specified LSF configuration category.
HTTP Method GET
Parameters None

Request

Method GET
Request-URI

/platform/ws/lsfconfig/{configId}/clusterparameters

/platform/ws/lsfconfig/{configId}/resources

/platform/ws/lsfconfig/{configId}/hosts

/platform/ws/lsfconfig/{configId}/hostgroups

/platform/ws/lsfconfig/{configId}/queues

/platform/ws/lsfconfig/{configId}/users

/platform/ws/lsfconfig/{configId}/usergroups

/platform/ws/lsfconfig/{configId}/resourcelimits

/platform/ws/lsfconfig/{configId}/resourcereservations
Request-Header Name Value
Accept application/xml, or application/json
If-Modified-Since (only if the client has a copy of the resource stored locally) {last modified time}
Message-Body empty

Response

Response Code
  • 200 Successful: Request was successful.
  • 304 Not Modified: The specified configuration category has not been modified.
  • 403 Forbidden: Access is restricted by role-based access control permissions.
  • 404 Not Found: The specified configuration category does not exist.
  • 500 Internal Server Error: Exception occurred.
Response-Header Name Value
Content-Type application/xml or application/json

Last-Modified (response code 200)

 {last modified time}
Message Body Success Message

If successful, returns detailed information about the specified LSF configuration category.

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lsfConfigResource name="%s" lastModifiedTime="%s">
    <section name="%s">
        <element>
            <attr key="%s" value="%s"/>
            <attr key="%s" value="%s"/>
         ...
        </element>
    </section>
</lsfConfigResource>
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>