GET /jobs/<sessionid>/<jobname>

Get a job configuration

Parameters

None

Example of request

GET http://localhost:5000/jobs/procfile/dummy

 {
    "name": "procfile.dummy",
    "processes": [
        1
    ],
    "running_out": 0,
    "active": true,
    "max_processes": 1,
    "config": {
        "numprocesses": 1,
        "args": [
            "-u",
            "dummy.py"
        ],
        "redirect_output": [
            "out",
            "err"
        ],
        "redirect_input": false,
        "cwd": "/home/benoitc/work/gaffer_env/src/gaffer/examples/procfile",
        "name": "dummy",
        "cmd": "python",
        "env": {}
    },
    "running": 1
}

A process configuration has the following parameters:

  • name: name of the process
  • cmd: program command, string)
  • args: the arguments for the command to run. Can be a list or a string.
  • env: a mapping containing the environment variables the command will run with. Optional
  • uid: int or str, user id
  • gid: int or st, user group id,
  • cwd: working dir
  • detach: the process is launched but won’t be monitored and won’t exit when the manager is stopped.
  • shell: boolean, run the script in a shell. (UNIX only)
  • redirect_output: list of io to redict (max 2) this is a list of custom labels to use for the redirection. Ex: [“a”, “b”] will redirect stdoutt & stderr and stdout events will be labeled “a”
  • redirect_input: Boolean (False is the default). Set it if you want to be able to write to stdin.
  • custom_streams: list of additional streams that should be created and passed to process. This is a list of streams labels. They become available through streams attribute.
  • custom_channels: list of additional channels that have been passed to process.

resources informations

Authentication Require an admin or a session manager
HTTP Method GET