Get parameters set for an LSF configuration file(GET)

Edit online

Description

URL

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

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

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

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

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

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

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

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

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

Gets parameter settings set for an LSF configuration file from the database with the last modified time set in the response header. Each LSF configuration file has its own last modified time.

If the client has a copy of the LSF configuration file stored locally, you can send a conditional GET request with an If-Modified-Since header. If the LSF configuration file 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 if a previous conditional PUT on a specified LSF configuration category returns 412 (Precondition Failed), 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 file.
HTTP Method GET
Parameters None

Request

Method GET
Request-URI

/platform/ws/lsfconfig/{configId}/lsf_conf

/platform/ws/lsfconfig/{configId}/ego_conf

/platform/ws/lsfconfig/{configId}/lsf_cluster

/platform/ws/lsfconfig/{configId}/lsf_shared

/platform/ws/lsfconfig/{configId}/lsb_params

/platform/ws/lsfconfig/{configId}/lsb_resources

/platform/ws/lsfconfig/{configId}/lsb_hosts

/platform/ws/lsfconfig/{configId}/lsb_queues

/platform/ws/lsfconfig/{configId}/lsb_users
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 file has not been modified.
  • 403 Forbidden: Access is restricted by role-based access control permissions.
  • 404 Not Found: The specified configuration file 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/lsfConfigFile.xsd.

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