Skip to content

Utilities.md

Latest commit

 

History

History
127 lines (87 loc) · 3.55 KB

Utilities.md

File metadata and controls

127 lines (87 loc) · 3.55 KB

WAS Utility APIs

These APIs provide general information about the Wolfram Application Server instance and offer administrative services.

Information [.applicationserver/info]

Retrieve Server Information [GET]

Use this to retrieve general information about the Wolfram Application Server cluster.

  • Request

      GET /.applicationserver/info

    Example:

      GET "http://applicationserver.wolfram.com/.applicationserver/info"

  • Response 200 (application/json)

    • Example:

        {
  	"resourceManager": "http://resources.applicationserver.wolfram.com",
  	"endpointManager": "http://endpoints.applicationserver.wolfram.com",
  	"nodefileManager": "http://nodefiles.applicationserver.wolfram.com",
  	"canonicalBaseURL": "http://applicationserver.wolfram.com",
  	"restartURL": "http://applicationserver.wolfram.com/.applicationserver/kernel/restart",
  	"wasVersion": "3.0",
  	"wolframEngineVersion": "13."
  }

Restart Container [GET]

Restart [.applicationserver/kernel/restart]

Use this to initiate a rolling restart of the Active Web Element Server instances (other services will not be affected). The API uses basic authentication and requires a username and password (set during cluster initiation). It returns a success message string.

  • Request

      GET /.applicationserver/kernel/restart

    Example:

      GET "http://applicationserver.wolfram.com/.applicationserver/kernel/restart"

  • Response 200 OK

    • Example:

        Container restarted successfully!

Kernel Initialization Status [GET]

Kernel Readiness [.applicationserver/kernel/readiness]

Use this API to get the kernel initialization status. If all kernels fully initialized the API will return "Kernels fully initialized" message with 200 status code.

Kernel Pool Status [GET]

Information about kernels in the kernel pool [.applicationserver/kernel/stats]

Use this API to get information about the kernels in a kernel pool.

  • Request

    GET /.applicationserver/kernel/stats Example:

    GET "http://applicationserver.wolfram.com/.applicationserver/kernel/stats"

  • Response 200 OK

    • Example:

      [
  {
    "poolName":"MSP",
    "note":null,
    "acquiredKernelPercentage":0.0,
    "numberWaitingForKernels":0,
    "configuredKernelCount":2,
    "liveKernelCount":2
  },
  {
    "poolName":"Public",
    "note":null,
    "acquiredKernelPercentage":50.0,
    "numberWaitingForKernels":0,
    "configuredKernelCount":2,
    "liveKernelCount":2
  }
]

  • Optional query parameter

    • pool={name,...}: restrict to a particular kernel pool

      • Example: GET "http://applicationserver.wolfram.com/.applicationserver/kernel/stats?pool=Public"
      • Response 200 OK

      [ { "poolName":"Public", "note":null, "acquiredKernelPercentage":50.0, "numberWaitingForKernels":0, "configuredKernelCount":2, "liveKernelCount":2 } ]

  • Optional query parameter

    • require-running-kernels=true (defaults to false): if true and the number of kernels in a pool, including leased kernels, (liveKernelCount) is 0 then the endpoint returns Response 500 Internal Server Error unless the configuredKernelCount for that pool is also 0.