Slurm Rest API
API to access and control Slurm.
More information: https://www.schedmd.com/
Contact Info: sales@schedmd.com
Version: 0.0.36
BasePath:
Apache 2.0
https://www.apache.org/licenses/LICENSE-2.0.html
Access
- APIKey KeyParamName:X-SLURM-USER-TOKEN KeyInQuery:false KeyInHeader:true
- APIKey KeyParamName:X-SLURM-USER-NAME KeyInQuery:false KeyInHeader:true
Methods
[ Jump to Models ]Table of Contents
Openapi
Slurm
delete /slurm/v0.0.36/job/{job_id}get /slurm/v0.0.36/diagget /slurm/v0.0.36/job/{job_id}get /slurm/v0.0.36/jobsget /slurm/v0.0.36/node/{node_name}get /slurm/v0.0.36/nodesget /slurm/v0.0.36/partition/{partition_name}get /slurm/v0.0.36/partitionsget /slurm/v0.0.36/pingpost /slurm/v0.0.36/job/submitpost /slurm/v0.0.36/job/{job_id}post /slurmdb/v0.0.36/clusterspost /slurmdb/v0.0.36/wckeysdelete /slurmdb/v0.0.36/account/{account_name}delete /slurmdb/v0.0.36/associationdelete /slurmdb/v0.0.36/cluster/{cluster_name}delete /slurmdb/v0.0.36/qos/{qos_name}delete /slurmdb/v0.0.36/user/{user_name}delete /slurmdb/v0.0.36/wckey/{wckey}get /slurmdb/v0.0.36/diagget /slurmdb/v0.0.36/account/{account_name}get /slurmdb/v0.0.36/accountsget /slurmdb/v0.0.36/associationget /slurmdb/v0.0.36/associationsget /slurmdb/v0.0.36/cluster/{cluster_name}get /slurmdb/v0.0.36/clustersget /slurmdb/v0.0.36/configget /slurmdb/v0.0.36/job/{job_id}get /slurmdb/v0.0.36/jobsget /slurmdb/v0.0.36/qosget /slurmdb/v0.0.36/qos/{qos_name}get /slurmdb/v0.0.36/tresget /slurmdb/v0.0.36/user/{user_name}get /slurmdb/v0.0.36/usersget /slurmdb/v0.0.36/wckey/{wckey}get /slurmdb/v0.0.36/wckeyspost /slurmdb/v0.0.36/configpost /slurmdb/v0.0.36/accountspost /slurmdb/v0.0.36/trespost /slurmdb/v0.0.36/users
Openapi
Up
get /openapi.jsonRetrieve OpenAPI Specification (openapiJsonGet)
Responses
200
OpenAPI Specification
Up
get /openapi/v3Retrieve OpenAPI Specification (openapiV3Get)
Responses
200
OpenAPI Specification
Up
get /openapi.yamlRetrieve OpenAPI Specification (openapiYamlGet)
Responses
200
OpenAPI SpecificationSlurm
Up
delete /slurm/v0.0.36/job/{job_id}cancel or signal job (slurmctldCancelJob)
Path parameters
job_id (required)
Path Parameter — Slurm Job ID default: null format: int64
Query parameters
signal (optional)
Query Parameter — signal to send to job default: null
Responses
200
job cancelled or sent signal500
job not found
Up
get /slurm/v0.0.36/diagget diagnostics (slurmctldDiag)
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ],
"statistics" : {
"schedule_cycle_per_minute" : 6,
"req_time_start" : 5,
"jobs_running" : 8,
"bf_cycle_max" : 6,
"bf_last_backfilled_jobs" : 3,
"bf_last_depth" : 6,
"bf_backfilled_het_jobs" : 6,
"bf_backfilled_jobs" : 6,
"bf_cycle_mean" : 2,
"job_states_ts" : 9,
"bf_queue_len" : 7,
"jobs_started" : 4,
"schedule_cycle_max" : 4,
"server_thread_count" : 5,
"dbd_agent_queue_size" : 3,
"jobs_pending" : 6,
"agent_count" : 7,
"bf_cycle_last" : 3,
"parts_packed" : 6,
"agent_thread_count" : 9,
"jobs_completed" : 5,
"bf_depth_mean" : 6,
"bf_active" : true,
"bf_depth_mean_try" : 3,
"schedule_cycle_mean" : 1,
"agent_queue_size" : 2,
"jobs_failed" : 9,
"gettimeofday_latency" : 2,
"bf_last_depth_try" : 5,
"req_time" : 1,
"bf_cycle_counter" : 1,
"schedule_queue_length" : 7,
"bf_queue_len_mean" : 0,
"schedule_cycle_total" : 1,
"bf_when_last_cycle" : 7,
"schedule_cycle_last" : 7,
"jobs_canceled" : 9,
"jobs_submitted" : 1,
"schedule_cycle_mean_depth" : 1
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
diagnostic results v0.0.36_diagdefault
unable to request ping test
Up
get /slurm/v0.0.36/job/{job_id}get job info (slurmctldGetJob)
Path parameters
job_id (required)
Path Parameter — Slurm Job ID default: null format: int64
Return type
Example data
Content-Type: application/json
{
"jobs" : [ {
"cluster" : "cluster",
"time_minimum" : "time_minimum",
"memory_per_tres" : "memory_per_tres",
"qos" : "qos",
"resize_time" : "resize_time",
"eligible_time" : "eligible_time",
"cpus_per_tres" : "cpus_per_tres",
"tasks" : "tasks",
"system_comment" : "system_comment",
"federation_siblings_active" : "federation_siblings_active",
"tasks_per_core" : "tasks_per_core",
"accrue_time" : "accrue_time",
"dependency" : "dependency",
"profile" : [ "profile", "profile" ],
"priority" : "priority",
"tres_per_job" : "tres_per_job",
"derived_exit_code" : "derived_exit_code",
"core_spec" : "core_spec",
"mcs_label" : "mcs_label",
"required_nodes" : "required_nodes",
"tres_bind" : "tres_bind",
"user_id" : "user_id",
"exit_code" : 0,
"federation_origin" : "federation_origin",
"shared" : "shared",
"tasks_per_board" : "tasks_per_board",
"user_name" : "user_name",
"flags" : [ "flags", "flags" ],
"standard_input" : "standard_input",
"admin_comment" : "admin_comment",
"cores_per_socket" : "cores_per_socket",
"job_state" : "job_state",
"current_working_directory" : "current_working_directory",
"standard_error" : "standard_error",
"array_job_id" : "array_job_id",
"cluster_features" : "cluster_features",
"partition" : "partition",
"threads_per_core" : "threads_per_core",
"tres_alloc_str" : "tres_alloc_str",
"memory_per_cpu" : "memory_per_cpu",
"cpu_frequency_minimum" : "cpu_frequency_minimum",
"node_count" : "node_count",
"deadline" : "deadline",
"memory_per_node" : "memory_per_node",
"state_reason" : "state_reason",
"het_job_offset" : "het_job_offset",
"end_time" : "end_time",
"sockets_per_board" : "sockets_per_board",
"nice" : "nice",
"last_sched_evaluation" : "last_sched_evaluation",
"tres_per_node" : "tres_per_node",
"burst_buffer" : "burst_buffer",
"licenses" : "licenses",
"excluded_nodes" : "excluded_nodes",
"array_max_tasks" : "array_max_tasks",
"het_job_id" : "het_job_id",
"sockets_per_node" : "sockets_per_node",
"time_limit" : "time_limit",
"minimum_cpus_per_node" : "minimum_cpus_per_node",
"tasks_per_socket" : "tasks_per_socket",
"batch_host" : "batch_host",
"max_cpus" : "max_cpus",
"cpu_frequency_maximum" : "cpu_frequency_maximum",
"features" : "features",
"het_job_id_set" : "het_job_id_set",
"state_description" : "state_description",
"show_flags" : [ "show_flags", "show_flags" ],
"array_task_id" : "array_task_id",
"minimum_tmp_disk_per_node" : "minimum_tmp_disk_per_node",
"tres_req_str" : "tres_req_str",
"burst_buffer_state" : "burst_buffer_state",
"tres_per_socket" : "tres_per_socket",
"array_task_string" : "array_task_string",
"submit_time" : "submit_time",
"wckey" : "wckey",
"max_nodes" : "max_nodes",
"batch_flag" : true,
"start_time" : "start_time",
"name" : "name",
"preempt_time" : "preempt_time",
"contiguous" : true,
"job_resources" : {
"nodes" : "nodes",
"allocated_nodes" : [ {
"memory" : 5,
"cores" : "{}",
"cpus" : "{}",
"sockets" : "{}"
}, {
"memory" : 5,
"cores" : "{}",
"cpus" : "{}",
"sockets" : "{}"
} ],
"allocated_cpus" : 6,
"allocated_hosts" : 1
},
"billable_tres" : "billable_tres",
"federation_siblings_viable" : "federation_siblings_viable",
"cpus_per_task" : "cpus_per_task",
"batch_features" : "batch_features",
"thread_spec" : "thread_spec",
"cpu_frequency_governor" : "cpu_frequency_governor",
"gres_detail" : [ "gres_detail", "gres_detail" ],
"restart_cnt" : "restart_cnt",
"resv_name" : "resv_name",
"delay_boot" : "delay_boot",
"reboot" : true,
"cpus" : "cpus",
"standard_output" : "standard_output",
"pre_sus_time" : "pre_sus_time",
"suspend_time" : "suspend_time",
"association_id" : "association_id",
"command" : "command",
"tres_freq" : "tres_freq",
"requeue" : true,
"tres_per_task" : "tres_per_task",
"nodes" : "nodes",
"group_id" : "group_id",
"job_id" : "job_id",
"comment" : "comment",
"account" : "account"
}, {
"cluster" : "cluster",
"time_minimum" : "time_minimum",
"memory_per_tres" : "memory_per_tres",
"qos" : "qos",
"resize_time" : "resize_time",
"eligible_time" : "eligible_time",
"cpus_per_tres" : "cpus_per_tres",
"tasks" : "tasks",
"system_comment" : "system_comment",
"federation_siblings_active" : "federation_siblings_active",
"tasks_per_core" : "tasks_per_core",
"accrue_time" : "accrue_time",
"dependency" : "dependency",
"profile" : [ "profile", "profile" ],
"priority" : "priority",
"tres_per_job" : "tres_per_job",
"derived_exit_code" : "derived_exit_code",
"core_spec" : "core_spec",
"mcs_label" : "mcs_label",
"required_nodes" : "required_nodes",
"tres_bind" : "tres_bind",
"user_id" : "user_id",
"exit_code" : 0,
"federation_origin" : "federation_origin",
"shared" : "shared",
"tasks_per_board" : "tasks_per_board",
"user_name" : "user_name",
"flags" : [ "flags", "flags" ],
"standard_input" : "standard_input",
"admin_comment" : "admin_comment",
"cores_per_socket" : "cores_per_socket",
"job_state" : "job_state",
"current_working_directory" : "current_working_directory",
"standard_error" : "standard_error",
"array_job_id" : "array_job_id",
"cluster_features" : "cluster_features",
"partition" : "partition",
"threads_per_core" : "threads_per_core",
"tres_alloc_str" : "tres_alloc_str",
"memory_per_cpu" : "memory_per_cpu",
"cpu_frequency_minimum" : "cpu_frequency_minimum",
"node_count" : "node_count",
"deadline" : "deadline",
"memory_per_node" : "memory_per_node",
"state_reason" : "state_reason",
"het_job_offset" : "het_job_offset",
"end_time" : "end_time",
"sockets_per_board" : "sockets_per_board",
"nice" : "nice",
"last_sched_evaluation" : "last_sched_evaluation",
"tres_per_node" : "tres_per_node",
"burst_buffer" : "burst_buffer",
"licenses" : "licenses",
"excluded_nodes" : "excluded_nodes",
"array_max_tasks" : "array_max_tasks",
"het_job_id" : "het_job_id",
"sockets_per_node" : "sockets_per_node",
"time_limit" : "time_limit",
"minimum_cpus_per_node" : "minimum_cpus_per_node",
"tasks_per_socket" : "tasks_per_socket",
"batch_host" : "batch_host",
"max_cpus" : "max_cpus",
"cpu_frequency_maximum" : "cpu_frequency_maximum",
"features" : "features",
"het_job_id_set" : "het_job_id_set",
"state_description" : "state_description",
"show_flags" : [ "show_flags", "show_flags" ],
"array_task_id" : "array_task_id",
"minimum_tmp_disk_per_node" : "minimum_tmp_disk_per_node",
"tres_req_str" : "tres_req_str",
"burst_buffer_state" : "burst_buffer_state",
"tres_per_socket" : "tres_per_socket",
"array_task_string" : "array_task_string",
"submit_time" : "submit_time",
"wckey" : "wckey",
"max_nodes" : "max_nodes",
"batch_flag" : true,
"start_time" : "start_time",
"name" : "name",
"preempt_time" : "preempt_time",
"contiguous" : true,
"job_resources" : {
"nodes" : "nodes",
"allocated_nodes" : [ {
"memory" : 5,
"cores" : "{}",
"cpus" : "{}",
"sockets" : "{}"
}, {
"memory" : 5,
"cores" : "{}",
"cpus" : "{}",
"sockets" : "{}"
} ],
"allocated_cpus" : 6,
"allocated_hosts" : 1
},
"billable_tres" : "billable_tres",
"federation_siblings_viable" : "federation_siblings_viable",
"cpus_per_task" : "cpus_per_task",
"batch_features" : "batch_features",
"thread_spec" : "thread_spec",
"cpu_frequency_governor" : "cpu_frequency_governor",
"gres_detail" : [ "gres_detail", "gres_detail" ],
"restart_cnt" : "restart_cnt",
"resv_name" : "resv_name",
"delay_boot" : "delay_boot",
"reboot" : true,
"cpus" : "cpus",
"standard_output" : "standard_output",
"pre_sus_time" : "pre_sus_time",
"suspend_time" : "suspend_time",
"association_id" : "association_id",
"command" : "command",
"tres_freq" : "tres_freq",
"requeue" : true,
"tres_per_task" : "tres_per_task",
"nodes" : "nodes",
"group_id" : "group_id",
"job_id" : "job_id",
"comment" : "comment",
"account" : "account"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
job(s) information v0.0.36_jobs_responsedefault
job not found
Up
get /slurm/v0.0.36/jobsget list of jobs (slurmctldGetJobs)
Return type
Example data
Content-Type: application/json
{
"jobs" : [ {
"cluster" : "cluster",
"time_minimum" : "time_minimum",
"memory_per_tres" : "memory_per_tres",
"qos" : "qos",
"resize_time" : "resize_time",
"eligible_time" : "eligible_time",
"cpus_per_tres" : "cpus_per_tres",
"tasks" : "tasks",
"system_comment" : "system_comment",
"federation_siblings_active" : "federation_siblings_active",
"tasks_per_core" : "tasks_per_core",
"accrue_time" : "accrue_time",
"dependency" : "dependency",
"profile" : [ "profile", "profile" ],
"priority" : "priority",
"tres_per_job" : "tres_per_job",
"derived_exit_code" : "derived_exit_code",
"core_spec" : "core_spec",
"mcs_label" : "mcs_label",
"required_nodes" : "required_nodes",
"tres_bind" : "tres_bind",
"user_id" : "user_id",
"exit_code" : 0,
"federation_origin" : "federation_origin",
"shared" : "shared",
"tasks_per_board" : "tasks_per_board",
"user_name" : "user_name",
"flags" : [ "flags", "flags" ],
"standard_input" : "standard_input",
"admin_comment" : "admin_comment",
"cores_per_socket" : "cores_per_socket",
"job_state" : "job_state",
"current_working_directory" : "current_working_directory",
"standard_error" : "standard_error",
"array_job_id" : "array_job_id",
"cluster_features" : "cluster_features",
"partition" : "partition",
"threads_per_core" : "threads_per_core",
"tres_alloc_str" : "tres_alloc_str",
"memory_per_cpu" : "memory_per_cpu",
"cpu_frequency_minimum" : "cpu_frequency_minimum",
"node_count" : "node_count",
"deadline" : "deadline",
"memory_per_node" : "memory_per_node",
"state_reason" : "state_reason",
"het_job_offset" : "het_job_offset",
"end_time" : "end_time",
"sockets_per_board" : "sockets_per_board",
"nice" : "nice",
"last_sched_evaluation" : "last_sched_evaluation",
"tres_per_node" : "tres_per_node",
"burst_buffer" : "burst_buffer",
"licenses" : "licenses",
"excluded_nodes" : "excluded_nodes",
"array_max_tasks" : "array_max_tasks",
"het_job_id" : "het_job_id",
"sockets_per_node" : "sockets_per_node",
"time_limit" : "time_limit",
"minimum_cpus_per_node" : "minimum_cpus_per_node",
"tasks_per_socket" : "tasks_per_socket",
"batch_host" : "batch_host",
"max_cpus" : "max_cpus",
"cpu_frequency_maximum" : "cpu_frequency_maximum",
"features" : "features",
"het_job_id_set" : "het_job_id_set",
"state_description" : "state_description",
"show_flags" : [ "show_flags", "show_flags" ],
"array_task_id" : "array_task_id",
"minimum_tmp_disk_per_node" : "minimum_tmp_disk_per_node",
"tres_req_str" : "tres_req_str",
"burst_buffer_state" : "burst_buffer_state",
"tres_per_socket" : "tres_per_socket",
"array_task_string" : "array_task_string",
"submit_time" : "submit_time",
"wckey" : "wckey",
"max_nodes" : "max_nodes",
"batch_flag" : true,
"start_time" : "start_time",
"name" : "name",
"preempt_time" : "preempt_time",
"contiguous" : true,
"job_resources" : {
"nodes" : "nodes",
"allocated_nodes" : [ {
"memory" : 5,
"cores" : "{}",
"cpus" : "{}",
"sockets" : "{}"
}, {
"memory" : 5,
"cores" : "{}",
"cpus" : "{}",
"sockets" : "{}"
} ],
"allocated_cpus" : 6,
"allocated_hosts" : 1
},
"billable_tres" : "billable_tres",
"federation_siblings_viable" : "federation_siblings_viable",
"cpus_per_task" : "cpus_per_task",
"batch_features" : "batch_features",
"thread_spec" : "thread_spec",
"cpu_frequency_governor" : "cpu_frequency_governor",
"gres_detail" : [ "gres_detail", "gres_detail" ],
"restart_cnt" : "restart_cnt",
"resv_name" : "resv_name",
"delay_boot" : "delay_boot",
"reboot" : true,
"cpus" : "cpus",
"standard_output" : "standard_output",
"pre_sus_time" : "pre_sus_time",
"suspend_time" : "suspend_time",
"association_id" : "association_id",
"command" : "command",
"tres_freq" : "tres_freq",
"requeue" : true,
"tres_per_task" : "tres_per_task",
"nodes" : "nodes",
"group_id" : "group_id",
"job_id" : "job_id",
"comment" : "comment",
"account" : "account"
}, {
"cluster" : "cluster",
"time_minimum" : "time_minimum",
"memory_per_tres" : "memory_per_tres",
"qos" : "qos",
"resize_time" : "resize_time",
"eligible_time" : "eligible_time",
"cpus_per_tres" : "cpus_per_tres",
"tasks" : "tasks",
"system_comment" : "system_comment",
"federation_siblings_active" : "federation_siblings_active",
"tasks_per_core" : "tasks_per_core",
"accrue_time" : "accrue_time",
"dependency" : "dependency",
"profile" : [ "profile", "profile" ],
"priority" : "priority",
"tres_per_job" : "tres_per_job",
"derived_exit_code" : "derived_exit_code",
"core_spec" : "core_spec",
"mcs_label" : "mcs_label",
"required_nodes" : "required_nodes",
"tres_bind" : "tres_bind",
"user_id" : "user_id",
"exit_code" : 0,
"federation_origin" : "federation_origin",
"shared" : "shared",
"tasks_per_board" : "tasks_per_board",
"user_name" : "user_name",
"flags" : [ "flags", "flags" ],
"standard_input" : "standard_input",
"admin_comment" : "admin_comment",
"cores_per_socket" : "cores_per_socket",
"job_state" : "job_state",
"current_working_directory" : "current_working_directory",
"standard_error" : "standard_error",
"array_job_id" : "array_job_id",
"cluster_features" : "cluster_features",
"partition" : "partition",
"threads_per_core" : "threads_per_core",
"tres_alloc_str" : "tres_alloc_str",
"memory_per_cpu" : "memory_per_cpu",
"cpu_frequency_minimum" : "cpu_frequency_minimum",
"node_count" : "node_count",
"deadline" : "deadline",
"memory_per_node" : "memory_per_node",
"state_reason" : "state_reason",
"het_job_offset" : "het_job_offset",
"end_time" : "end_time",
"sockets_per_board" : "sockets_per_board",
"nice" : "nice",
"last_sched_evaluation" : "last_sched_evaluation",
"tres_per_node" : "tres_per_node",
"burst_buffer" : "burst_buffer",
"licenses" : "licenses",
"excluded_nodes" : "excluded_nodes",
"array_max_tasks" : "array_max_tasks",
"het_job_id" : "het_job_id",
"sockets_per_node" : "sockets_per_node",
"time_limit" : "time_limit",
"minimum_cpus_per_node" : "minimum_cpus_per_node",
"tasks_per_socket" : "tasks_per_socket",
"batch_host" : "batch_host",
"max_cpus" : "max_cpus",
"cpu_frequency_maximum" : "cpu_frequency_maximum",
"features" : "features",
"het_job_id_set" : "het_job_id_set",
"state_description" : "state_description",
"show_flags" : [ "show_flags", "show_flags" ],
"array_task_id" : "array_task_id",
"minimum_tmp_disk_per_node" : "minimum_tmp_disk_per_node",
"tres_req_str" : "tres_req_str",
"burst_buffer_state" : "burst_buffer_state",
"tres_per_socket" : "tres_per_socket",
"array_task_string" : "array_task_string",
"submit_time" : "submit_time",
"wckey" : "wckey",
"max_nodes" : "max_nodes",
"batch_flag" : true,
"start_time" : "start_time",
"name" : "name",
"preempt_time" : "preempt_time",
"contiguous" : true,
"job_resources" : {
"nodes" : "nodes",
"allocated_nodes" : [ {
"memory" : 5,
"cores" : "{}",
"cpus" : "{}",
"sockets" : "{}"
}, {
"memory" : 5,
"cores" : "{}",
"cpus" : "{}",
"sockets" : "{}"
} ],
"allocated_cpus" : 6,
"allocated_hosts" : 1
},
"billable_tres" : "billable_tres",
"federation_siblings_viable" : "federation_siblings_viable",
"cpus_per_task" : "cpus_per_task",
"batch_features" : "batch_features",
"thread_spec" : "thread_spec",
"cpu_frequency_governor" : "cpu_frequency_governor",
"gres_detail" : [ "gres_detail", "gres_detail" ],
"restart_cnt" : "restart_cnt",
"resv_name" : "resv_name",
"delay_boot" : "delay_boot",
"reboot" : true,
"cpus" : "cpus",
"standard_output" : "standard_output",
"pre_sus_time" : "pre_sus_time",
"suspend_time" : "suspend_time",
"association_id" : "association_id",
"command" : "command",
"tres_freq" : "tres_freq",
"requeue" : true,
"tres_per_task" : "tres_per_task",
"nodes" : "nodes",
"group_id" : "group_id",
"job_id" : "job_id",
"comment" : "comment",
"account" : "account"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
job(s) information v0.0.36_jobs_responsedefault
job not found
Up
get /slurm/v0.0.36/node/{node_name}get node info (slurmctldGetNode)
Path parameters
node_name (required)
Path Parameter — Slurm Node Name default: null
Return type
Example data
Content-Type: application/json
{
"nodes" : [ {
"reason" : "reason",
"boards" : 0,
"active_features" : "active_features",
"reason_set_by_user" : "reason_set_by_user",
"slurmd_start_time" : 4,
"features" : "features",
"hostname" : "hostname",
"cores" : 1,
"slurmd_version" : "slurmd_version",
"reason_changed_at" : 2,
"operating_system" : "operating_system",
"tres" : "tres",
"cpu_binding" : 5,
"state" : "state",
"sockets" : 7,
"architecture" : "architecture",
"owner" : "owner",
"address" : "address",
"cpus" : 7,
"free_memory" : 2,
"gres" : "gres",
"gres_drained" : "gres_drained",
"threads" : 1,
"weight" : 1,
"boot_time" : 6,
"gres_used" : "gres_used",
"mcs_label" : "mcs_label",
"real_memory" : 3,
"burstbuffer_network_address" : "burstbuffer_network_address",
"port" : 9,
"name" : "name",
"comment" : "comment",
"next_state_after_reboot" : "next_state_after_reboot",
"temporary_disk" : 1,
"cpu_load" : 5
}, {
"reason" : "reason",
"boards" : 0,
"active_features" : "active_features",
"reason_set_by_user" : "reason_set_by_user",
"slurmd_start_time" : 4,
"features" : "features",
"hostname" : "hostname",
"cores" : 1,
"slurmd_version" : "slurmd_version",
"reason_changed_at" : 2,
"operating_system" : "operating_system",
"tres" : "tres",
"cpu_binding" : 5,
"state" : "state",
"sockets" : 7,
"architecture" : "architecture",
"owner" : "owner",
"address" : "address",
"cpus" : 7,
"free_memory" : 2,
"gres" : "gres",
"gres_drained" : "gres_drained",
"threads" : 1,
"weight" : 1,
"boot_time" : 6,
"gres_used" : "gres_used",
"mcs_label" : "mcs_label",
"real_memory" : 3,
"burstbuffer_network_address" : "burstbuffer_network_address",
"port" : 9,
"name" : "name",
"comment" : "comment",
"next_state_after_reboot" : "next_state_after_reboot",
"temporary_disk" : 1,
"cpu_load" : 5
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
node information v0.0.36_nodes_responsedefault
node not found
Up
get /slurm/v0.0.36/nodesget all node info (slurmctldGetNodes)
Return type
Example data
Content-Type: application/json
{
"nodes" : [ {
"reason" : "reason",
"boards" : 0,
"active_features" : "active_features",
"reason_set_by_user" : "reason_set_by_user",
"slurmd_start_time" : 4,
"features" : "features",
"hostname" : "hostname",
"cores" : 1,
"slurmd_version" : "slurmd_version",
"reason_changed_at" : 2,
"operating_system" : "operating_system",
"tres" : "tres",
"cpu_binding" : 5,
"state" : "state",
"sockets" : 7,
"architecture" : "architecture",
"owner" : "owner",
"address" : "address",
"cpus" : 7,
"free_memory" : 2,
"gres" : "gres",
"gres_drained" : "gres_drained",
"threads" : 1,
"weight" : 1,
"boot_time" : 6,
"gres_used" : "gres_used",
"mcs_label" : "mcs_label",
"real_memory" : 3,
"burstbuffer_network_address" : "burstbuffer_network_address",
"port" : 9,
"name" : "name",
"comment" : "comment",
"next_state_after_reboot" : "next_state_after_reboot",
"temporary_disk" : 1,
"cpu_load" : 5
}, {
"reason" : "reason",
"boards" : 0,
"active_features" : "active_features",
"reason_set_by_user" : "reason_set_by_user",
"slurmd_start_time" : 4,
"features" : "features",
"hostname" : "hostname",
"cores" : 1,
"slurmd_version" : "slurmd_version",
"reason_changed_at" : 2,
"operating_system" : "operating_system",
"tres" : "tres",
"cpu_binding" : 5,
"state" : "state",
"sockets" : 7,
"architecture" : "architecture",
"owner" : "owner",
"address" : "address",
"cpus" : 7,
"free_memory" : 2,
"gres" : "gres",
"gres_drained" : "gres_drained",
"threads" : 1,
"weight" : 1,
"boot_time" : 6,
"gres_used" : "gres_used",
"mcs_label" : "mcs_label",
"real_memory" : 3,
"burstbuffer_network_address" : "burstbuffer_network_address",
"port" : 9,
"name" : "name",
"comment" : "comment",
"next_state_after_reboot" : "next_state_after_reboot",
"temporary_disk" : 1,
"cpu_load" : 5
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
node information v0.0.36_nodes_responsedefault
no nodes in cluster
Up
get /slurm/v0.0.36/partition/{partition_name}get partition info (slurmctldGetPartition)
Path parameters
partition_name (required)
Path Parameter — Slurm Partition Name default: null
Return type
Example data
Content-Type: application/json
{
"partitions" : [ {
"max_time_limit" : 7,
"maximum_cpus_per_node" : 5,
"over_time_limit" : 3,
"denied_accounts" : "denied_accounts",
"flags" : [ "flags", "flags" ],
"maximum_memory_per_node" : 5,
"total_cpus" : 1,
"billing_weights" : "billing_weights",
"default_memory_per_cpu" : 0,
"allowed_qos" : "allowed_qos",
"nodes_online" : 7,
"min_nodes_per_job" : 9,
"qos" : "qos",
"default_time_limit" : 6,
"denied_qos" : "denied_qos",
"priority_job_factor" : 2,
"tres" : "tres",
"allowed_allocation_nodes" : "allowed_allocation_nodes",
"preemption_grace_time" : 1,
"allowed_accounts" : "allowed_accounts",
"alternative" : "alternative",
"preemption_mode" : "preemption_mode",
"nodes" : "nodes",
"name" : "name",
"allowed_groups" : "allowed_groups",
"total_nodes" : 1,
"maximum_nodes_per_job" : 2,
"priority_tier" : 4
}, {
"max_time_limit" : 7,
"maximum_cpus_per_node" : 5,
"over_time_limit" : 3,
"denied_accounts" : "denied_accounts",
"flags" : [ "flags", "flags" ],
"maximum_memory_per_node" : 5,
"total_cpus" : 1,
"billing_weights" : "billing_weights",
"default_memory_per_cpu" : 0,
"allowed_qos" : "allowed_qos",
"nodes_online" : 7,
"min_nodes_per_job" : 9,
"qos" : "qos",
"default_time_limit" : 6,
"denied_qos" : "denied_qos",
"priority_job_factor" : 2,
"tres" : "tres",
"allowed_allocation_nodes" : "allowed_allocation_nodes",
"preemption_grace_time" : 1,
"allowed_accounts" : "allowed_accounts",
"alternative" : "alternative",
"preemption_mode" : "preemption_mode",
"nodes" : "nodes",
"name" : "name",
"allowed_groups" : "allowed_groups",
"total_nodes" : 1,
"maximum_nodes_per_job" : 2,
"priority_tier" : 4
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
partition information v0.0.36_partitions_responsedefault
no partitions found
Up
get /slurm/v0.0.36/partitionsget all partition info (slurmctldGetPartitions)
Return type
Example data
Content-Type: application/json
{
"partitions" : [ {
"max_time_limit" : 7,
"maximum_cpus_per_node" : 5,
"over_time_limit" : 3,
"denied_accounts" : "denied_accounts",
"flags" : [ "flags", "flags" ],
"maximum_memory_per_node" : 5,
"total_cpus" : 1,
"billing_weights" : "billing_weights",
"default_memory_per_cpu" : 0,
"allowed_qos" : "allowed_qos",
"nodes_online" : 7,
"min_nodes_per_job" : 9,
"qos" : "qos",
"default_time_limit" : 6,
"denied_qos" : "denied_qos",
"priority_job_factor" : 2,
"tres" : "tres",
"allowed_allocation_nodes" : "allowed_allocation_nodes",
"preemption_grace_time" : 1,
"allowed_accounts" : "allowed_accounts",
"alternative" : "alternative",
"preemption_mode" : "preemption_mode",
"nodes" : "nodes",
"name" : "name",
"allowed_groups" : "allowed_groups",
"total_nodes" : 1,
"maximum_nodes_per_job" : 2,
"priority_tier" : 4
}, {
"max_time_limit" : 7,
"maximum_cpus_per_node" : 5,
"over_time_limit" : 3,
"denied_accounts" : "denied_accounts",
"flags" : [ "flags", "flags" ],
"maximum_memory_per_node" : 5,
"total_cpus" : 1,
"billing_weights" : "billing_weights",
"default_memory_per_cpu" : 0,
"allowed_qos" : "allowed_qos",
"nodes_online" : 7,
"min_nodes_per_job" : 9,
"qos" : "qos",
"default_time_limit" : 6,
"denied_qos" : "denied_qos",
"priority_job_factor" : 2,
"tres" : "tres",
"allowed_allocation_nodes" : "allowed_allocation_nodes",
"preemption_grace_time" : 1,
"allowed_accounts" : "allowed_accounts",
"alternative" : "alternative",
"preemption_mode" : "preemption_mode",
"nodes" : "nodes",
"name" : "name",
"allowed_groups" : "allowed_groups",
"total_nodes" : 1,
"maximum_nodes_per_job" : 2,
"priority_tier" : 4
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
partition information v0.0.36_partitions_responsedefault
no partitions found
Up
get /slurm/v0.0.36/pingping test (slurmctldPing)
Return type
Example data
Content-Type: application/json
{
"pings" : [ {
"mode" : "mode",
"hostname" : "hostname",
"ping" : "UP",
"status" : 0
}, {
"mode" : "mode",
"hostname" : "hostname",
"ping" : "UP",
"status" : 0
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
results of ping test v0.0.36_pingsdefault
unable to request ping test
Up
post /slurm/v0.0.36/job/submitsubmit new job (slurmctldSubmitJob)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/x-yaml
Request body
v0.0.36_job_submission v0.0.36_job_submission (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"job_id" : 0,
"step_id" : "step_id",
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ],
"job_submit_user_msg" : "job_submit_user_msg"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
job submitted v0.0.36_job_submission_responsedefault
job rejected
Up
post /slurm/v0.0.36/job/{job_id}update job (slurmctldUpdateJob)
Path parameters
job_id (required)
Path Parameter — Slurm Job ID default: null format: int64
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/x-yaml
Request body
v0.0.36_job_properties v0.0.36_job_properties (required)
Body Parameter —
Responses
200
job information500
job not found
Up
post /slurmdb/v0.0.36/clustersAdd clusters (slurmdbdAddClusters)
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of clusters dbv0.0.36_response_cluster_adddefault
Unable to add cluster
Up
post /slurmdb/v0.0.36/wckeysAdd wckeys (slurmdbdAddWckeys)
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of wckeys dbv0.0.36_response_wckey_adddefault
Unable to add wckey
Up
delete /slurmdb/v0.0.36/account/{account_name}Delete account (slurmdbdDeleteAccount)
Path parameters
account_name (required)
Path Parameter — Slurm Account Name default: null
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Delete account dbv0.0.36_response_account_deletedefault
Unable to delete account
Up
delete /slurmdb/v0.0.36/associationDelete association (slurmdbdDeleteAssociation)
Query parameters
cluster (optional)
Query Parameter — Cluster name default: null
account (required)
Query Parameter — Account name default: null
user (required)
Query Parameter — User name default: null
partition (optional)
Query Parameter — Partition Name default: null
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Delete associations dbv0.0.36_response_association_deletedefault
Association not found or unable to delete association
Up
delete /slurmdb/v0.0.36/cluster/{cluster_name}Delete cluster (slurmdbdDeleteCluster)
Path parameters
cluster_name (required)
Path Parameter — Slurm cluster name default: null
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Delete cluster dbv0.0.36_response_cluster_deletedefault
Cluster not found or unable to delete cluster
Up
delete /slurmdb/v0.0.36/qos/{qos_name}Delete QOS (slurmdbdDeleteQos)
Path parameters
qos_name (required)
Path Parameter — Slurm QOS Name default: null
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Delete qos dbv0.0.36_response_qos_deletedefault
Unable to delete QOS
Up
delete /slurmdb/v0.0.36/user/{user_name}Delete user (slurmdbdDeleteUser)
Path parameters
user_name (required)
Path Parameter — Slurm User Name default: null
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Delete user dbv0.0.36_response_user_deletedefault
User not found or unable to delete user
Up
delete /slurmdb/v0.0.36/wckey/{wckey}Delete wckey (slurmdbdDeleteWckey)
Path parameters
wckey (required)
Path Parameter — Slurm wckey name default: null
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Delete wckey dbv0.0.36_response_wckey_deletedefault
wckey not found or unable to delete wckey
Up
get /slurmdb/v0.0.36/diagGet slurmdb diagnostics (slurmdbdDiag)
Return type
Example data
Content-Type: application/json
{
"time_start" : 0,
"RPCs" : [ {
"rpc" : "rpc",
"count" : 7,
"time" : {
"average" : 9,
"total" : 3
}
}, {
"rpc" : "rpc",
"count" : 7,
"time" : {
"average" : 9,
"total" : 3
}
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ],
"rollups" : [ {
"max_cycle" : 5,
"last_cycle" : 1,
"mean_cycles" : 2,
"last_run" : 6,
"type" : "type",
"total_time" : 5
}, {
"max_cycle" : 5,
"last_cycle" : 1,
"mean_cycles" : 2,
"last_run" : 6,
"type" : "type",
"total_time" : 5
} ],
"users" : [ {
"count" : 2,
"time" : {
"average" : 4,
"total" : 7
},
"user" : "user"
}, {
"count" : 2,
"time" : {
"average" : 4,
"total" : 7
},
"user" : "user"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Dictionary of statistics dbv0.0.36_diagdefault
Unable to query diagnostics
Up
get /slurmdb/v0.0.36/account/{account_name}Get account info (slurmdbdGetAccount)
Path parameters
account_name (required)
Path Parameter — Slurm Account Name default: null
Return type
Example data
Content-Type: application/json
{
"accounts" : [ {
"associations" : [ {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
} ],
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"organization" : "organization",
"name" : "name",
"flags" : [ "flags", "flags" ],
"description" : "description"
}, {
"associations" : [ {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
} ],
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"organization" : "organization",
"name" : "name",
"flags" : [ "flags", "flags" ],
"description" : "description"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of accounts dbv0.0.36_account_infodefault
Account not found
Up
get /slurmdb/v0.0.36/accountsGet account list (slurmdbdGetAccounts)
Return type
Example data
Content-Type: application/json
{
"accounts" : [ {
"associations" : [ {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
} ],
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"organization" : "organization",
"name" : "name",
"flags" : [ "flags", "flags" ],
"description" : "description"
}, {
"associations" : [ {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
} ],
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"organization" : "organization",
"name" : "name",
"flags" : [ "flags", "flags" ],
"description" : "description"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of accounts dbv0.0.36_account_infodefault
Account not found
Up
get /slurmdb/v0.0.36/associationGet association info (slurmdbdGetAssociation)
Query parameters
cluster (optional)
Query Parameter — Cluster name default: null
account (optional)
Query Parameter — Account name default: null
user (optional)
Query Parameter — User name default: null
partition (optional)
Query Parameter — Partition Name default: null
Return type
Example data
Content-Type: application/json
{
"associations" : [ {
"cluster" : "cluster",
"shares_raw" : 2,
"max" : {
"jobs" : {
"per" : {
"wall_clock" : 6
}
},
"tres" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"minutes" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"account" : {
"wall_clock" : 1
}
}
},
"usage" : {
"fairshare_factor" : 3.616076749251911,
"normalized_shares" : 7.386281948385884,
"effective_normalized_usage" : 1.2315135367772556,
"job_count" : 1,
"group_used_wallclock" : 9.301444243932576,
"normalized_priority" : 4,
"accrue_job_count" : 7,
"fairshare_shares" : 2,
"fairshare_level" : 6.84685269835264,
"raw_usage" : 1
},
"flags" : [ "flags", "flags" ],
"priority" : 5,
"parent_account" : "parent_account",
"default" : {
"qos" : "qos"
},
"min" : {
"priority_threshold" : 5
},
"partition" : "partition",
"qos" : [ "qos", "qos" ],
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"shares_raw" : 2,
"max" : {
"jobs" : {
"per" : {
"wall_clock" : 6
}
},
"tres" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"minutes" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"account" : {
"wall_clock" : 1
}
}
},
"usage" : {
"fairshare_factor" : 3.616076749251911,
"normalized_shares" : 7.386281948385884,
"effective_normalized_usage" : 1.2315135367772556,
"job_count" : 1,
"group_used_wallclock" : 9.301444243932576,
"normalized_priority" : 4,
"accrue_job_count" : 7,
"fairshare_shares" : 2,
"fairshare_level" : 6.84685269835264,
"raw_usage" : 1
},
"flags" : [ "flags", "flags" ],
"priority" : 5,
"parent_account" : "parent_account",
"default" : {
"qos" : "qos"
},
"min" : {
"priority_threshold" : 5
},
"partition" : "partition",
"qos" : [ "qos", "qos" ],
"user" : "user",
"account" : "account"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of associations dbv0.0.36_associations_infodefault
Association not found
Up
get /slurmdb/v0.0.36/associationsGet association list (slurmdbdGetAssociations)
Return type
Example data
Content-Type: application/json
{
"associations" : [ {
"cluster" : "cluster",
"shares_raw" : 2,
"max" : {
"jobs" : {
"per" : {
"wall_clock" : 6
}
},
"tres" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"minutes" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"account" : {
"wall_clock" : 1
}
}
},
"usage" : {
"fairshare_factor" : 3.616076749251911,
"normalized_shares" : 7.386281948385884,
"effective_normalized_usage" : 1.2315135367772556,
"job_count" : 1,
"group_used_wallclock" : 9.301444243932576,
"normalized_priority" : 4,
"accrue_job_count" : 7,
"fairshare_shares" : 2,
"fairshare_level" : 6.84685269835264,
"raw_usage" : 1
},
"flags" : [ "flags", "flags" ],
"priority" : 5,
"parent_account" : "parent_account",
"default" : {
"qos" : "qos"
},
"min" : {
"priority_threshold" : 5
},
"partition" : "partition",
"qos" : [ "qos", "qos" ],
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"shares_raw" : 2,
"max" : {
"jobs" : {
"per" : {
"wall_clock" : 6
}
},
"tres" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"minutes" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"account" : {
"wall_clock" : 1
}
}
},
"usage" : {
"fairshare_factor" : 3.616076749251911,
"normalized_shares" : 7.386281948385884,
"effective_normalized_usage" : 1.2315135367772556,
"job_count" : 1,
"group_used_wallclock" : 9.301444243932576,
"normalized_priority" : 4,
"accrue_job_count" : 7,
"fairshare_shares" : 2,
"fairshare_level" : 6.84685269835264,
"raw_usage" : 1
},
"flags" : [ "flags", "flags" ],
"priority" : 5,
"parent_account" : "parent_account",
"default" : {
"qos" : "qos"
},
"min" : {
"priority_threshold" : 5
},
"partition" : "partition",
"qos" : [ "qos", "qos" ],
"user" : "user",
"account" : "account"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of associations dbv0.0.36_associations_infodefault
Association not found
Up
get /slurmdb/v0.0.36/cluster/{cluster_name}Get cluster info (slurmdbdGetCluster)
Path parameters
cluster_name (required)
Path Parameter — Slurm cluster name default: null
Return type
Example data
Content-Type: application/json
{
"associations" : {
"root" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}
},
"controller" : {
"port" : 0,
"host" : "host"
},
"nodes" : "nodes",
"flags" : [ "flags", "flags" ],
"name" : "name",
"rpc_version" : 6,
"tres" : [ {
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}, {
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
} ],
"select_plugin" : "select_plugin"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Cluster information dbv0.0.36_cluster_infodefault
Cluster not found
Up
get /slurmdb/v0.0.36/clustersGet cluster list (slurmdbdGetClusters)
Return type
Example data
Content-Type: application/json
{
"associations" : {
"root" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}
},
"controller" : {
"port" : 0,
"host" : "host"
},
"nodes" : "nodes",
"flags" : [ "flags", "flags" ],
"name" : "name",
"rpc_version" : 6,
"tres" : [ {
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}, {
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
} ],
"select_plugin" : "select_plugin"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of clusters dbv0.0.36_cluster_infodefault
Cluster not found
Up
get /slurmdb/v0.0.36/configDump all configuration information (slurmdbdGetDbConfig)
Return type
Example data
Content-Type: application/json
{
"associations" : [ {
"cluster" : "cluster",
"shares_raw" : 2,
"max" : {
"jobs" : {
"per" : {
"wall_clock" : 6
}
},
"tres" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"minutes" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"account" : {
"wall_clock" : 1
}
}
},
"usage" : {
"fairshare_factor" : 3.616076749251911,
"normalized_shares" : 7.386281948385884,
"effective_normalized_usage" : 1.2315135367772556,
"job_count" : 1,
"group_used_wallclock" : 9.301444243932576,
"normalized_priority" : 4,
"accrue_job_count" : 7,
"fairshare_shares" : 2,
"fairshare_level" : 6.84685269835264,
"raw_usage" : 1
},
"flags" : [ "flags", "flags" ],
"priority" : 5,
"parent_account" : "parent_account",
"default" : {
"qos" : "qos"
},
"min" : {
"priority_threshold" : 5
},
"partition" : "partition",
"qos" : [ "qos", "qos" ],
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"shares_raw" : 2,
"max" : {
"jobs" : {
"per" : {
"wall_clock" : 6
}
},
"tres" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"minutes" : {
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"account" : {
"wall_clock" : 1
}
}
},
"usage" : {
"fairshare_factor" : 3.616076749251911,
"normalized_shares" : 7.386281948385884,
"effective_normalized_usage" : 1.2315135367772556,
"job_count" : 1,
"group_used_wallclock" : 9.301444243932576,
"normalized_priority" : 4,
"accrue_job_count" : 7,
"fairshare_shares" : 2,
"fairshare_level" : 6.84685269835264,
"raw_usage" : 1
},
"flags" : [ "flags", "flags" ],
"priority" : 5,
"parent_account" : "parent_account",
"default" : {
"qos" : "qos"
},
"min" : {
"priority_threshold" : 5
},
"partition" : "partition",
"qos" : [ "qos", "qos" ],
"user" : "user",
"account" : "account"
} ],
"qos" : [ {
"flags" : [ "flags", "flags" ],
"usage_threshold" : 3.5571952270680973,
"description" : "description",
"usage_factor" : 6.438423552598547,
"id" : "id",
"priority" : 9,
"limits" : {
"min" : {
"priority_threshold" : 6,
"tres" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
},
"max" : {
"jobs" : {
"per" : {
"user" : 5,
"account" : 4
}
},
"accruing" : {
"per" : {
"user" : 9,
"account" : 9
}
},
"wall_clock" : {
"per" : {
"qos" : 7,
"job" : 1
}
},
"tres" : {
"minutes" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
}
},
"preempt" : {
"mode" : [ "mode", "mode" ],
"exempt_time" : 8,
"list" : [ "list", "list" ]
}
}, {
"flags" : [ "flags", "flags" ],
"usage_threshold" : 3.5571952270680973,
"description" : "description",
"usage_factor" : 6.438423552598547,
"id" : "id",
"priority" : 9,
"limits" : {
"min" : {
"priority_threshold" : 6,
"tres" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
},
"max" : {
"jobs" : {
"per" : {
"user" : 5,
"account" : 4
}
},
"accruing" : {
"per" : {
"user" : 9,
"account" : 9
}
},
"wall_clock" : {
"per" : {
"qos" : 7,
"job" : 1
}
},
"tres" : {
"minutes" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
}
},
"preempt" : {
"mode" : [ "mode", "mode" ],
"exempt_time" : 8,
"list" : [ "list", "list" ]
}
} ],
"wckeys" : [ {
"cluster" : "cluster",
"name" : "name",
"flags" : [ "flags", "flags" ],
"accounts" : [ "accounts", "accounts" ],
"id" : 6,
"user" : "user"
}, {
"cluster" : "cluster",
"name" : "name",
"flags" : [ "flags", "flags" ],
"accounts" : [ "accounts", "accounts" ],
"id" : 6,
"user" : "user"
} ],
"tres" : [ {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}, {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
} ],
"accounts" : [ {
"associations" : [ {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
} ],
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"organization" : "organization",
"name" : "name",
"flags" : [ "flags", "flags" ],
"description" : "description"
}, {
"associations" : [ {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
} ],
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"organization" : "organization",
"name" : "name",
"flags" : [ "flags", "flags" ],
"description" : "description"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ],
"users" : [ {
"associations" : {
"root" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}
},
"default" : {
"wckey" : "wckey",
"account" : "account"
},
"administrator_level" : "administrator_level",
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"name" : "name"
}, {
"associations" : {
"root" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}
},
"default" : {
"wckey" : "wckey",
"account" : "account"
},
"administrator_level" : "administrator_level",
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"name" : "name"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
slurmdbd configuration dbv0.0.36_config_infodefault
Unable to dump config
Up
get /slurmdb/v0.0.36/job/{job_id}Get job info (slurmdbdGetJob)
Path parameters
job_id (required)
Path Parameter — Slurm Job ID default: null format: int64
Return type
Example data
Content-Type: application/json
{
"jobs" : [ {
"cluster" : "cluster",
"flags" : [ "flags", "flags" ],
"association" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
},
"allocation_nodes" : "allocation_nodes",
"working_directory" : "working_directory",
"constraints" : "constraints",
"required" : {
"memory" : 6,
"CPUs" : 9
},
"partition" : "partition",
"qos" : "qos",
"array" : {
"task" : "task",
"job_id" : 6,
"task_id" : 5,
"limits" : {
"max" : {
"running" : {
"tasks" : 1
}
}
}
},
"het" : {
"job_id" : "{}",
"job_offset" : "{}"
},
"reservation" : {
"name" : 9,
"id" : 8
},
"tres" : {
"requested" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"state" : {
"current" : "current",
"previous" : "previous"
},
"mcs" : {
"label" : "label"
},
"group" : "group",
"wckey" : {
"wckey" : "wckey",
"flags" : [ "flags", "flags" ]
},
"priority" : 9,
"steps" : [ {
"nodes" : {
"count" : 2,
"range" : "range"
},
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"kill_request_user" : "kill_request_user",
"CPU" : {
"governor" : [ "governor", "governor" ],
"requested_frequency" : {
"min" : 6,
"max" : 5
}
},
"pid" : "pid",
"step" : {
"task" : {
"distribution" : "distribution"
},
"job_id" : 3,
"het" : {
"component" : 7
},
"name" : "name",
"tres" : {
"consumed" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"requested" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"id" : "id"
},
"time" : {
"elapsed" : 6,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"start" : 6,
"end" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 1
},
"state" : "state",
"tasks" : {
"count" : 6
},
"statistics" : {
"CPU" : {
"actual_frequency" : 6
},
"energy" : {
"consumed" : 3
}
}
}, {
"nodes" : {
"count" : 2,
"range" : "range"
},
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"kill_request_user" : "kill_request_user",
"CPU" : {
"governor" : [ "governor", "governor" ],
"requested_frequency" : {
"min" : 6,
"max" : 5
}
},
"pid" : "pid",
"step" : {
"task" : {
"distribution" : "distribution"
},
"job_id" : 3,
"het" : {
"component" : 7
},
"name" : "name",
"tres" : {
"consumed" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"requested" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"id" : "id"
},
"time" : {
"elapsed" : 6,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"start" : 6,
"end" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 1
},
"state" : "state",
"tasks" : {
"count" : 6
},
"statistics" : {
"CPU" : {
"actual_frequency" : 6
},
"energy" : {
"consumed" : 3
}
}
} ],
"derived_exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"nodes" : "nodes",
"job_id" : 5,
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"name" : "name",
"kill_request_user" : "kill_request_user",
"comment" : {
"administrator" : "administrator",
"system" : "system",
"job" : "job"
},
"time" : {
"elapsed" : 5,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"eligible" : 2,
"start" : 9,
"limit" : 7,
"end" : 7,
"submission" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 2
},
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"flags" : [ "flags", "flags" ],
"association" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
},
"allocation_nodes" : "allocation_nodes",
"working_directory" : "working_directory",
"constraints" : "constraints",
"required" : {
"memory" : 6,
"CPUs" : 9
},
"partition" : "partition",
"qos" : "qos",
"array" : {
"task" : "task",
"job_id" : 6,
"task_id" : 5,
"limits" : {
"max" : {
"running" : {
"tasks" : 1
}
}
}
},
"het" : {
"job_id" : "{}",
"job_offset" : "{}"
},
"reservation" : {
"name" : 9,
"id" : 8
},
"tres" : {
"requested" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"state" : {
"current" : "current",
"previous" : "previous"
},
"mcs" : {
"label" : "label"
},
"group" : "group",
"wckey" : {
"wckey" : "wckey",
"flags" : [ "flags", "flags" ]
},
"priority" : 9,
"steps" : [ {
"nodes" : {
"count" : 2,
"range" : "range"
},
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"kill_request_user" : "kill_request_user",
"CPU" : {
"governor" : [ "governor", "governor" ],
"requested_frequency" : {
"min" : 6,
"max" : 5
}
},
"pid" : "pid",
"step" : {
"task" : {
"distribution" : "distribution"
},
"job_id" : 3,
"het" : {
"component" : 7
},
"name" : "name",
"tres" : {
"consumed" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"requested" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"id" : "id"
},
"time" : {
"elapsed" : 6,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"start" : 6,
"end" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 1
},
"state" : "state",
"tasks" : {
"count" : 6
},
"statistics" : {
"CPU" : {
"actual_frequency" : 6
},
"energy" : {
"consumed" : 3
}
}
}, {
"nodes" : {
"count" : 2,
"range" : "range"
},
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"kill_request_user" : "kill_request_user",
"CPU" : {
"governor" : [ "governor", "governor" ],
"requested_frequency" : {
"min" : 6,
"max" : 5
}
},
"pid" : "pid",
"step" : {
"task" : {
"distribution" : "distribution"
},
"job_id" : 3,
"het" : {
"component" : 7
},
"name" : "name",
"tres" : {
"consumed" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"requested" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"id" : "id"
},
"time" : {
"elapsed" : 6,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"start" : 6,
"end" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 1
},
"state" : "state",
"tasks" : {
"count" : 6
},
"statistics" : {
"CPU" : {
"actual_frequency" : 6
},
"energy" : {
"consumed" : 3
}
}
} ],
"derived_exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"nodes" : "nodes",
"job_id" : 5,
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"name" : "name",
"kill_request_user" : "kill_request_user",
"comment" : {
"administrator" : "administrator",
"system" : "system",
"job" : "job"
},
"time" : {
"elapsed" : 5,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"eligible" : 2,
"start" : 9,
"limit" : 7,
"end" : 7,
"submission" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 2
},
"user" : "user",
"account" : "account"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Job description dbv0.0.36_job_infodefault
Unable to find job
Up
get /slurmdb/v0.0.36/jobsGet job list (slurmdbdGetJobs)
Query parameters
submit_time (optional)
Query Parameter — Filter by submission time
Accepted formats:
HH:MM[:SS] [AM|PM]
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
MM/DD[/YY]-HH:MM[:SS]
YYYY-MM-DD[THH:MM[:SS]] default: null
start_time (optional)
Query Parameter — Filter by start time
Accepted formats:
HH:MM[:SS] [AM|PM]
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
MM/DD[/YY]-HH:MM[:SS]
YYYY-MM-DD[THH:MM[:SS]] default: null
end_time (optional)
Query Parameter — Filter by end time
Accepted formats:
HH:MM[:SS] [AM|PM]
MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
MM/DD[/YY]-HH:MM[:SS]
YYYY-MM-DD[THH:MM[:SS]] default: null
account (optional)
Query Parameter — Comma delimited list of accounts to match default: null
association (optional)
Query Parameter — Comma delimited list of associations to match default: null
cluster (optional)
Query Parameter — Comma delimited list of cluster to match default: null
constraints (optional)
Query Parameter — Comma delimited list of constraints to match default: null
cpus_max (optional)
Query Parameter — Number of CPUs high range default: null
cpus_min (optional)
Query Parameter — Number of CPUs low range default: null
skip_steps (optional)
Query Parameter — Report job step information default: null
disable_wait_for_result (optional)
Query Parameter — Disable waiting for result from slurmdbd default: null
exit_code (optional)
Query Parameter — Exit code of job default: null
format (optional)
Query Parameter — Comma delimited list of formats to match default: null
group (optional)
Query Parameter — Comma delimited list of groups to match default: null
job_name (optional)
Query Parameter — Comma delimited list of job names to match default: null
nodes_max (optional)
Query Parameter — Number of nodes high range default: null
nodes_min (optional)
Query Parameter — Number of nodes low range default: null
partition (optional)
Query Parameter — Comma delimited list of partitions to match default: null
qos (optional)
Query Parameter — Comma delimited list of QOS to match default: null
reason (optional)
Query Parameter — Comma delimited list of job reasons to match default: null
reservation (optional)
Query Parameter — Comma delimited list of reservations to match default: null
state (optional)
Query Parameter — Comma delimited list of states to match default: null
step (optional)
Query Parameter — Comma delimited list of job steps to match default: null
node (optional)
Query Parameter — Comma delimited list of used nodes to match default: null
users (optional)
Query Parameter — Comma delimited list of users to match default: null
wckey (optional)
Query Parameter — Comma delimited list of wckeys to match default: null
Return type
Example data
Content-Type: application/json
{
"jobs" : [ {
"cluster" : "cluster",
"flags" : [ "flags", "flags" ],
"association" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
},
"allocation_nodes" : "allocation_nodes",
"working_directory" : "working_directory",
"constraints" : "constraints",
"required" : {
"memory" : 6,
"CPUs" : 9
},
"partition" : "partition",
"qos" : "qos",
"array" : {
"task" : "task",
"job_id" : 6,
"task_id" : 5,
"limits" : {
"max" : {
"running" : {
"tasks" : 1
}
}
}
},
"het" : {
"job_id" : "{}",
"job_offset" : "{}"
},
"reservation" : {
"name" : 9,
"id" : 8
},
"tres" : {
"requested" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"state" : {
"current" : "current",
"previous" : "previous"
},
"mcs" : {
"label" : "label"
},
"group" : "group",
"wckey" : {
"wckey" : "wckey",
"flags" : [ "flags", "flags" ]
},
"priority" : 9,
"steps" : [ {
"nodes" : {
"count" : 2,
"range" : "range"
},
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"kill_request_user" : "kill_request_user",
"CPU" : {
"governor" : [ "governor", "governor" ],
"requested_frequency" : {
"min" : 6,
"max" : 5
}
},
"pid" : "pid",
"step" : {
"task" : {
"distribution" : "distribution"
},
"job_id" : 3,
"het" : {
"component" : 7
},
"name" : "name",
"tres" : {
"consumed" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"requested" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"id" : "id"
},
"time" : {
"elapsed" : 6,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"start" : 6,
"end" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 1
},
"state" : "state",
"tasks" : {
"count" : 6
},
"statistics" : {
"CPU" : {
"actual_frequency" : 6
},
"energy" : {
"consumed" : 3
}
}
}, {
"nodes" : {
"count" : 2,
"range" : "range"
},
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"kill_request_user" : "kill_request_user",
"CPU" : {
"governor" : [ "governor", "governor" ],
"requested_frequency" : {
"min" : 6,
"max" : 5
}
},
"pid" : "pid",
"step" : {
"task" : {
"distribution" : "distribution"
},
"job_id" : 3,
"het" : {
"component" : 7
},
"name" : "name",
"tres" : {
"consumed" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"requested" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"id" : "id"
},
"time" : {
"elapsed" : 6,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"start" : 6,
"end" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 1
},
"state" : "state",
"tasks" : {
"count" : 6
},
"statistics" : {
"CPU" : {
"actual_frequency" : 6
},
"energy" : {
"consumed" : 3
}
}
} ],
"derived_exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"nodes" : "nodes",
"job_id" : 5,
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"name" : "name",
"kill_request_user" : "kill_request_user",
"comment" : {
"administrator" : "administrator",
"system" : "system",
"job" : "job"
},
"time" : {
"elapsed" : 5,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"eligible" : 2,
"start" : 9,
"limit" : 7,
"end" : 7,
"submission" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 2
},
"user" : "user",
"account" : "account"
}, {
"cluster" : "cluster",
"flags" : [ "flags", "flags" ],
"association" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
},
"allocation_nodes" : "allocation_nodes",
"working_directory" : "working_directory",
"constraints" : "constraints",
"required" : {
"memory" : 6,
"CPUs" : 9
},
"partition" : "partition",
"qos" : "qos",
"array" : {
"task" : "task",
"job_id" : 6,
"task_id" : 5,
"limits" : {
"max" : {
"running" : {
"tasks" : 1
}
}
}
},
"het" : {
"job_id" : "{}",
"job_offset" : "{}"
},
"reservation" : {
"name" : 9,
"id" : 8
},
"tres" : {
"requested" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"state" : {
"current" : "current",
"previous" : "previous"
},
"mcs" : {
"label" : "label"
},
"group" : "group",
"wckey" : {
"wckey" : "wckey",
"flags" : [ "flags", "flags" ]
},
"priority" : 9,
"steps" : [ {
"nodes" : {
"count" : 2,
"range" : "range"
},
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"kill_request_user" : "kill_request_user",
"CPU" : {
"governor" : [ "governor", "governor" ],
"requested_frequency" : {
"min" : 6,
"max" : 5
}
},
"pid" : "pid",
"step" : {
"task" : {
"distribution" : "distribution"
},
"job_id" : 3,
"het" : {
"component" : 7
},
"name" : "name",
"tres" : {
"consumed" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"requested" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"id" : "id"
},
"time" : {
"elapsed" : 6,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"start" : 6,
"end" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 1
},
"state" : "state",
"tasks" : {
"count" : 6
},
"statistics" : {
"CPU" : {
"actual_frequency" : 6
},
"energy" : {
"consumed" : 3
}
}
}, {
"nodes" : {
"count" : 2,
"range" : "range"
},
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"kill_request_user" : "kill_request_user",
"CPU" : {
"governor" : [ "governor", "governor" ],
"requested_frequency" : {
"min" : 6,
"max" : 5
}
},
"pid" : "pid",
"step" : {
"task" : {
"distribution" : "distribution"
},
"job_id" : 3,
"het" : {
"component" : 7
},
"name" : "name",
"tres" : {
"consumed" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"requested" : {
"average" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"total" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"min" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"max" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"allocated" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
},
"id" : "id"
},
"time" : {
"elapsed" : 6,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"start" : 6,
"end" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 1
},
"state" : "state",
"tasks" : {
"count" : 6
},
"statistics" : {
"CPU" : {
"actual_frequency" : 6
},
"energy" : {
"consumed" : 3
}
}
} ],
"derived_exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"nodes" : "nodes",
"job_id" : 5,
"exit_code" : {
"return_code" : 1,
"signal" : {
"name" : "name",
"signal_id" : 4
},
"status" : "status"
},
"name" : "name",
"kill_request_user" : "kill_request_user",
"comment" : {
"administrator" : "administrator",
"system" : "system",
"job" : "job"
},
"time" : {
"elapsed" : 5,
"total" : {
"seconds" : 1,
"microseconds" : 1
},
"system" : {
"seconds" : 4,
"microseconds" : 7
},
"eligible" : 2,
"start" : 9,
"limit" : 7,
"end" : 7,
"submission" : 3,
"user" : {
"seconds" : 1,
"microseconds" : 6
},
"suspended" : 2
},
"user" : "user",
"account" : "account"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of jobs dbv0.0.36_job_infodefault
Unable to query jobs
Up
get /slurmdb/v0.0.36/qosGet QOS list (slurmdbdGetQos)
Return type
Example data
Content-Type: application/json
{
"qos" : [ {
"flags" : [ "flags", "flags" ],
"usage_threshold" : 3.5571952270680973,
"description" : "description",
"usage_factor" : 6.438423552598547,
"id" : "id",
"priority" : 9,
"limits" : {
"min" : {
"priority_threshold" : 6,
"tres" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
},
"max" : {
"jobs" : {
"per" : {
"user" : 5,
"account" : 4
}
},
"accruing" : {
"per" : {
"user" : 9,
"account" : 9
}
},
"wall_clock" : {
"per" : {
"qos" : 7,
"job" : 1
}
},
"tres" : {
"minutes" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
}
},
"preempt" : {
"mode" : [ "mode", "mode" ],
"exempt_time" : 8,
"list" : [ "list", "list" ]
}
}, {
"flags" : [ "flags", "flags" ],
"usage_threshold" : 3.5571952270680973,
"description" : "description",
"usage_factor" : 6.438423552598547,
"id" : "id",
"priority" : 9,
"limits" : {
"min" : {
"priority_threshold" : 6,
"tres" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
},
"max" : {
"jobs" : {
"per" : {
"user" : 5,
"account" : 4
}
},
"accruing" : {
"per" : {
"user" : 9,
"account" : 9
}
},
"wall_clock" : {
"per" : {
"qos" : 7,
"job" : 1
}
},
"tres" : {
"minutes" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
}
},
"preempt" : {
"mode" : [ "mode", "mode" ],
"exempt_time" : 8,
"list" : [ "list", "list" ]
}
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of QOS' dbv0.0.36_qos_infodefault
QOS not found
Up
get /slurmdb/v0.0.36/qos/{qos_name}Get QOS info (slurmdbdGetSingleQos)
Path parameters
qos_name (required)
Path Parameter — Slurm QOS Name default: null
Return type
Example data
Content-Type: application/json
{
"qos" : [ {
"flags" : [ "flags", "flags" ],
"usage_threshold" : 3.5571952270680973,
"description" : "description",
"usage_factor" : 6.438423552598547,
"id" : "id",
"priority" : 9,
"limits" : {
"min" : {
"priority_threshold" : 6,
"tres" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
},
"max" : {
"jobs" : {
"per" : {
"user" : 5,
"account" : 4
}
},
"accruing" : {
"per" : {
"user" : 9,
"account" : 9
}
},
"wall_clock" : {
"per" : {
"qos" : 7,
"job" : 1
}
},
"tres" : {
"minutes" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
}
},
"preempt" : {
"mode" : [ "mode", "mode" ],
"exempt_time" : 8,
"list" : [ "list", "list" ]
}
}, {
"flags" : [ "flags", "flags" ],
"usage_threshold" : 3.5571952270680973,
"description" : "description",
"usage_factor" : 6.438423552598547,
"id" : "id",
"priority" : 9,
"limits" : {
"min" : {
"priority_threshold" : 6,
"tres" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
},
"max" : {
"jobs" : {
"per" : {
"user" : 5,
"account" : 4
}
},
"accruing" : {
"per" : {
"user" : 9,
"account" : 9
}
},
"wall_clock" : {
"per" : {
"qos" : 7,
"job" : 1
}
},
"tres" : {
"minutes" : {
"per" : {
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
},
"per" : {
"node" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"job" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"user" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
},
"account" : {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}
}
}
}
},
"preempt" : {
"mode" : [ "mode", "mode" ],
"exempt_time" : 8,
"list" : [ "list", "list" ]
}
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
QOS information dbv0.0.36_qos_infodefault
QOS not found
Up
get /slurmdb/v0.0.36/tresGet TRES info (slurmdbdGetTres)
Return type
Example data
Content-Type: application/json
{
"tres" : [ {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
}, {
"name" : "name",
"count" : 7,
"id" : 0,
"type" : "type"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of TRES dbv0.0.36_tres_infodefault
Unable to retrieve TRES
Up
get /slurmdb/v0.0.36/user/{user_name}Get user info (slurmdbdGetUser)
Path parameters
user_name (required)
Path Parameter — Slurm User Name default: null
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ],
"users" : [ {
"associations" : {
"root" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}
},
"default" : {
"wckey" : "wckey",
"account" : "account"
},
"administrator_level" : "administrator_level",
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"name" : "name"
}, {
"associations" : {
"root" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}
},
"default" : {
"wckey" : "wckey",
"account" : "account"
},
"administrator_level" : "administrator_level",
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"name" : "name"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of users dbv0.0.36_user_infodefault
User not found
Up
get /slurmdb/v0.0.36/usersGet user list (slurmdbdGetUsers)
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ],
"users" : [ {
"associations" : {
"root" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}
},
"default" : {
"wckey" : "wckey",
"account" : "account"
},
"administrator_level" : "administrator_level",
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"name" : "name"
}, {
"associations" : {
"root" : {
"cluster" : "cluster",
"partition" : "partition",
"user" : "user",
"account" : "account"
}
},
"default" : {
"wckey" : "wckey",
"account" : "account"
},
"administrator_level" : "administrator_level",
"coordinators" : [ {
"name" : "name",
"direct" : 0
}, {
"name" : "name",
"direct" : 0
} ],
"name" : "name"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of users dbv0.0.36_user_infodefault
User not found
Up
get /slurmdb/v0.0.36/wckey/{wckey}Get wckey info (slurmdbdGetWckey)
Path parameters
wckey (required)
Path Parameter — Slurm wckey name default: null
Return type
Example data
Content-Type: application/json
{
"wckeys" : [ {
"cluster" : "cluster",
"name" : "name",
"flags" : [ "flags", "flags" ],
"accounts" : [ "accounts", "accounts" ],
"id" : 6,
"user" : "user"
}, {
"cluster" : "cluster",
"name" : "name",
"flags" : [ "flags", "flags" ],
"accounts" : [ "accounts", "accounts" ],
"id" : 6,
"user" : "user"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of wckey dbv0.0.36_wckey_infodefault
wckey not found
Up
get /slurmdb/v0.0.36/wckeysGet wckey list (slurmdbdGetWckeys)
Return type
Example data
Content-Type: application/json
{
"wckeys" : [ {
"cluster" : "cluster",
"name" : "name",
"flags" : [ "flags", "flags" ],
"accounts" : [ "accounts", "accounts" ],
"id" : 6,
"user" : "user"
}, {
"cluster" : "cluster",
"name" : "name",
"flags" : [ "flags", "flags" ],
"accounts" : [ "accounts", "accounts" ],
"id" : 6,
"user" : "user"
} ],
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of wckeys dbv0.0.36_wckey_infodefault
wckey not found
Up
post /slurmdb/v0.0.36/configLoad all configuration information (slurmdbdSetDbConfig)
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Load config dbv0.0.36_config_responsedefault
Unable to set config
Up
post /slurmdb/v0.0.36/accountsUpdate accounts (slurmdbdUpdateAccount)
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Add/update list of accounts dbv0.0.36_account_responsedefault
Unable to add or update accounts
Up
post /slurmdb/v0.0.36/tresSet TRES info (slurmdbdUpdateTres)
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
List of TRES dbv0.0.36_response_tresdefault
Unable to update TRES
Up
post /slurmdb/v0.0.36/usersUpdate user (slurmdbdUpdateUsers)
Return type
Example data
Content-Type: application/json
{
"errors" : [ {
"errno" : 0,
"error" : "error"
}, {
"errno" : 0,
"error" : "error"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/x-yaml
Responses
200
Update users dbv0.0.36_response_user_updatedefault
User not found or not able to update userModels
[ Jump to Methods ]Table of Contents
dbv0.0.36_account-dbv0.0.36_account_info-dbv0.0.36_account_response-dbv0.0.36_association-dbv0.0.36_association_short_info-dbv0.0.36_associations_info-dbv0.0.36_cluster_info-dbv0.0.36_config_info-dbv0.0.36_config_response-dbv0.0.36_coordinator_info-dbv0.0.36_diag-dbv0.0.36_error-dbv0.0.36_job-dbv0.0.36_job_exit_code-dbv0.0.36_job_info-dbv0.0.36_job_step-dbv0.0.36_qos-dbv0.0.36_qos_info-dbv0.0.36_response_account_delete-dbv0.0.36_response_association_delete-dbv0.0.36_response_cluster_add-dbv0.0.36_response_cluster_delete-dbv0.0.36_response_qos_delete-dbv0.0.36_response_tres-dbv0.0.36_response_user_delete-dbv0.0.36_response_user_update-dbv0.0.36_response_wckey_add-dbv0.0.36_response_wckey_delete-dbv0.0.36_tres_info-dbv0.0.36_tres_list-dbv0.0.36_user-dbv0.0.36_user_info-dbv0.0.36_wckey-dbv0.0.36_wckey_info-dbv0_0_36_association_default-dbv0_0_36_association_max-dbv0_0_36_association_max_jobs-dbv0_0_36_association_max_jobs_per-dbv0_0_36_association_max_per-dbv0_0_36_association_max_per_account-dbv0_0_36_association_max_tres-dbv0_0_36_association_max_tres_minutes-dbv0_0_36_association_max_tres_minutes_per-dbv0_0_36_association_max_tres_per-dbv0_0_36_association_min-dbv0_0_36_association_usage-dbv0_0_36_cluster_info_associations-dbv0_0_36_cluster_info_controller-dbv0_0_36_diag_RPCs-dbv0_0_36_diag_rollups-dbv0_0_36_diag_time-dbv0_0_36_diag_time_1-dbv0_0_36_diag_users-dbv0_0_36_job_array-dbv0_0_36_job_array_limits-dbv0_0_36_job_array_limits_max-dbv0_0_36_job_array_limits_max_running-dbv0_0_36_job_comment-dbv0_0_36_job_exit_code_signal-dbv0_0_36_job_het-dbv0_0_36_job_mcs-dbv0_0_36_job_required-dbv0_0_36_job_reservation-dbv0_0_36_job_state-dbv0_0_36_job_step_CPU-dbv0_0_36_job_step_CPU_requested_frequency-dbv0_0_36_job_step_nodes-dbv0_0_36_job_step_statistics-dbv0_0_36_job_step_statistics_CPU-dbv0_0_36_job_step_statistics_energy-dbv0_0_36_job_step_step-dbv0_0_36_job_step_step_het-dbv0_0_36_job_step_step_task-dbv0_0_36_job_step_step_tres-dbv0_0_36_job_step_step_tres_requested-dbv0_0_36_job_step_tasks-dbv0_0_36_job_step_time-dbv0_0_36_job_time-dbv0_0_36_job_time_system-dbv0_0_36_job_time_total-dbv0_0_36_job_time_user-dbv0_0_36_job_tres-dbv0_0_36_job_wckey-dbv0_0_36_qos_limits-dbv0_0_36_qos_limits_max-dbv0_0_36_qos_limits_max_accruing-dbv0_0_36_qos_limits_max_accruing_per-dbv0_0_36_qos_limits_max_jobs-dbv0_0_36_qos_limits_max_jobs_per-dbv0_0_36_qos_limits_max_tres-dbv0_0_36_qos_limits_max_tres_minutes-dbv0_0_36_qos_limits_max_tres_minutes_per-dbv0_0_36_qos_limits_max_tres_per-dbv0_0_36_qos_limits_max_wall_clock-dbv0_0_36_qos_limits_max_wall_clock_per-dbv0_0_36_qos_limits_min-dbv0_0_36_qos_limits_min_tres-dbv0_0_36_qos_limits_min_tres_per-dbv0_0_36_qos_preempt-dbv0_0_36_user_associations-dbv0_0_36_user_default-v0.0.36_diag-v0.0.36_error-v0.0.36_job_properties-v0.0.36_job_resources-v0.0.36_job_response_properties-v0.0.36_job_submission-v0.0.36_job_submission_response-v0.0.36_jobs_response-v0.0.36_node-v0.0.36_node_allocation-v0.0.36_nodes_response-v0.0.36_partition-v0.0.36_partitions_response-v0.0.36_ping-v0.0.36_pings-v0.0.36_signal-v0_0_36_diag_statistics-
dbv0.0.36_account - Up
Account description
associations (optional)
array[dbv0.0.36_association_short_info] List of assigned associations
coordinators (optional)
array[dbv0.0.36_coordinator_info] List of assigned coordinators
description (optional)
String Description of account
name (optional)
String Name of account
organization (optional)
String Assigned organization of account
flags (optional)
array[String] List of properties of account
dbv0.0.36_account_info - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
accounts (optional)
array[dbv0.0.36_account] List of accounts
dbv0.0.36_account_response - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_association - Up
Association description
account (optional)
String Assigned account
cluster (optional)
String Assigned cluster
default (optional)
flags (optional)
array[String] List of properties of association
max (optional)
min (optional)
parent_account (optional)
String Parent account name
partition (optional)
String Assigned partition
priority (optional)
Integer Assigned priority
qos (optional)
array[String] Assigned QOS
shares_raw (optional)
Integer Raw fairshare shares
usage (optional)
user (optional)
String Assigned user
dbv0.0.36_associations_info - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
associations (optional)
array[dbv0.0.36_association] Array of associations
dbv0.0.36_cluster_info - Up
controller (optional)
flags (optional)
array[String] List of properties of cluster
name (optional)
String Cluster name
nodes (optional)
String Assigned nodes
select_plugin (optional)
String Configured select plugin
associations (optional)
rpc_version (optional)
Integer Number rpc version
tres (optional)
array[dbv0.0.36_response_tres] List of TRES in cluster
dbv0.0.36_config_info - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
tres (optional)
array[dbv0.0.36_tres_list] Array of TRES
accounts (optional)
array[dbv0.0.36_account] Array of accounts
associations (optional)
array[dbv0.0.36_association] Array of associations
users (optional)
array[dbv0.0.36_user] Array of users
qos (optional)
array[dbv0.0.36_qos] Array of qos
wckeys (optional)
array[dbv0.0.36_wckey] Array of wckeys
dbv0.0.36_config_response - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_diag - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
time_start (optional)
Integer Unix timestamp of start time
rollups (optional)
RPCs (optional)
users (optional)
dbv0.0.36_job - Up
Single job description
account (optional)
String Account charged by job
comment (optional)
allocation_nodes (optional)
String Nodes allocated to job
array (optional)
time (optional)
association (optional)
cluster (optional)
String Assigned cluster
constraints (optional)
String Constraints on job
derived_exit_code (optional)
exit_code (optional)
flags (optional)
array[String] List of properties of job
group (optional)
String User's group to run job
het (optional)
job_id (optional)
Integer Job id
name (optional)
String Assigned job name
mcs (optional)
nodes (optional)
String List of nodes allocated for job
partition (optional)
String Assigned job's partition
priority (optional)
Integer Priority
qos (optional)
String Assigned qos name
required (optional)
kill_request_user (optional)
String User who requested job killed
reservation (optional)
state (optional)
steps (optional)
array[dbv0.0.36_job_step] Job step description
tres (optional)
user (optional)
String Job user
wckey (optional)
working_directory (optional)
String Directory where job was initially started
dbv0.0.36_job_exit_code - Up
dbv0.0.36_job_info - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
jobs (optional)
array[dbv0.0.36_job] Array of jobs
dbv0.0.36_job_step - Up
dbv0.0.36_qos - Up
QOS description
description (optional)
String QOS description
flags (optional)
array[String] List of properties of QOS
id (optional)
String Database id
limits (optional)
preempt (optional)
priority (optional)
Integer QOS priority
usage_factor (optional)
BigDecimal Usage factor
usage_threshold (optional)
BigDecimal Usage threshold
dbv0.0.36_qos_info - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
qos (optional)
array[dbv0.0.36_qos] Array of QOS
dbv0.0.36_response_account_delete - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_association_delete - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_cluster_add - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_cluster_delete - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_qos_delete - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_tres - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_user_delete - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_user_update - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_wckey_add - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_response_wckey_delete - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
dbv0.0.36_tres_info - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
tres (optional)
array[dbv0.0.36_tres_list] Array of tres
dbv0.0.36_user - Up
User description
administrator_level (optional)
String Description of administrator level
associations (optional)
coordinators (optional)
array[dbv0.0.36_coordinator_info] List of assigned coordinators
default (optional)
name (optional)
String User name
dbv0.0.36_user_info - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
users (optional)
array[dbv0.0.36_user] Array of users
dbv0.0.36_wckey - Up
accounts (optional)
array[String] List of assigned accounts
cluster (optional)
String Cluster name
id (optional)
Integer wckey database unique id
name (optional)
String wckey name
user (optional)
String wckey user
flags (optional)
array[String] List of properties of wckey
dbv0.0.36_wckey_info - Up
errors (optional)
array[dbv0.0.36_error] Slurm errors
wckeys (optional)
array[dbv0.0.36_wckey] List of wckeys
dbv0_0_36_association_max_jobs_per - Up
Max jobs per settings
wall_clock (optional)
Integer Max wallclock per job
dbv0_0_36_association_max_per_account - Up
Max per accounting settings
wall_clock (optional)
Integer Max wallclock per account
dbv0_0_36_association_max_tres - Up
Max TRES settings
per (optional)
total (optional)
minutes (optional)
dbv0_0_36_association_max_tres_minutes - Up
Max TRES minutes settings
dbv0_0_36_association_max_tres_per - Up
Max TRES per settings
dbv0_0_36_association_min - Up
Min settings
priority_threshold (optional)
Integer Min priority threshold
dbv0_0_36_association_usage - Up
Association usage
accrue_job_count (optional)
Integer Jobs accuring priority
group_used_wallclock (optional)
BigDecimal Group used wallclock time (s)
fairshare_factor (optional)
BigDecimal Fairshare factor
fairshare_shares (optional)
Integer Fairshare shares
normalized_priority (optional)
Integer Currently active jobs
normalized_shares (optional)
BigDecimal Normalized shares
effective_normalized_usage (optional)
BigDecimal Effective normalized usage
raw_usage (optional)
Integer Raw usage
job_count (optional)
Integer Total jobs submitted
fairshare_level (optional)
BigDecimal Fairshare level
dbv0_0_36_cluster_info_controller - Up
Information about controller
dbv0_0_36_diag_RPCs - Up
Statistics by RPC type
dbv0_0_36_diag_rollups - Up
Rollup statistics
type (optional)
String Type of rollup
last_run (optional)
Integer Timestamp of last rollup
last_cycle (optional)
Integer Timestamp of last cycle
max_cycle (optional)
Integer Max time of all cycles
total_time (optional)
Integer Total time (s) spent doing rollup
mean_cycles (optional)
Integer Average time (s) of cycle
dbv0_0_36_diag_time - Up
Time values
dbv0_0_36_diag_time_1 - Up
Time values
dbv0_0_36_diag_users - Up
Statistics by user RPCs
dbv0_0_36_job_array - Up
Array properties (optional)
dbv0_0_36_job_array_limits_max_running - Up
Limits on array settings
tasks (optional)
Integer Max running tasks in array at any one time
dbv0_0_36_job_comment - Up
Job comments by type
dbv0_0_36_job_exit_code_signal - Up
Signal details (if signaled)
dbv0_0_36_job_het - Up
Heterogeneous Job details (optional)
dbv0_0_36_job_required - Up
Job run requirements
dbv0_0_36_job_reservation - Up
Reservation usage details
dbv0_0_36_job_state - Up
State properties of job
dbv0_0_36_job_step_CPU - Up
CPU properties
dbv0_0_36_job_step_CPU_requested_frequency - Up
CPU frequency requested
dbv0_0_36_job_step_nodes - Up
Node details
dbv0_0_36_job_step_statistics_CPU - Up
Statistics of CPU
actual_frequency (optional)
Integer Actual frequency of CPU during step
dbv0_0_36_job_step_statistics_energy - Up
Statistics of energy
consumed (optional)
Integer Energy consumed during step
dbv0_0_36_job_step_step - Up
Step details
dbv0_0_36_job_step_step_het - Up
Heterogeneous job details
component (optional)
Integer Parent HetJob component id
dbv0_0_36_job_step_step_task - Up
Task properties
distribution (optional)
String Task distribution type
dbv0_0_36_job_step_step_tres - Up
TRES usage
requested (optional)
consumed (optional)
allocated (optional)
dbv0_0_36_job_step_step_tres_requested - Up
TRES requested for job
average (optional)
max (optional)
min (optional)
total (optional)
dbv0_0_36_job_step_time - Up
Time properties
dbv0_0_36_job_time - Up
Time properties
elapsed (optional)
Integer Total time elapsed
eligible (optional)
Integer Total time eligible to run
end (optional)
Integer Timestamp of when job ended
start (optional)
Integer Timestamp of when job started
submission (optional)
Integer Timestamp of when job submitted
suspended (optional)
Integer Timestamp of when job last suspended
system (optional)
total (optional)
user (optional)
limit (optional)
Integer Job wall clock time limit
dbv0_0_36_job_time_system - Up
System time values
dbv0_0_36_job_time_total - Up
System time values
dbv0_0_36_job_time_user - Up
User land time values
dbv0_0_36_job_tres - Up
TRES settings
dbv0_0_36_job_wckey - Up
Job assigned wckey details
dbv0_0_36_qos_limits - Up
Assigned limits
dbv0_0_36_qos_limits_max - Up
Limits on max settings
wall_clock (optional)
jobs (optional)
accruing (optional)
tres (optional)
dbv0_0_36_qos_limits_max_accruing_per - Up
Max accuring priority per setting
dbv0_0_36_qos_limits_max_jobs_per - Up
Limits on jobs per settings
dbv0_0_36_qos_limits_max_tres_minutes_per - Up
Max TRES minutes per settings
job (optional)
account (optional)
user (optional)
dbv0_0_36_qos_limits_max_tres_per - Up
Max TRES per settings
account (optional)
job (optional)
node (optional)
user (optional)
dbv0_0_36_qos_limits_max_wall_clock_per - Up
Limit on wallclock per settings
dbv0_0_36_qos_limits_min - Up
Min limit settings
dbv0_0_36_qos_preempt - Up
Preemption settings
list (optional)
array[String] List of preemptable QOS
mode (optional)
array[String] List of preemption modes
exempt_time (optional)
Integer Grace period (s) before jobs can preempted
dbv0_0_36_user_default - Up
Default settings
v0.0.36_job_properties - Up
account (optional)
String Charge resources used by this job to specified account.
account_gather_freqency (optional)
String Define the job accounting and profiling sampling intervals.
argv (optional)
array[String] Arguments to the script.
array (optional)
String Submit a job array, multiple jobs to be executed with identical parameters. The indexes specification identifies what array index values should be used.
batch_features (optional)
String features required for batch script's node
begin_time (optional)
String Submit the batch script to the Slurm controller immediately, like normal, but tell the controller to defer the allocation of the job until the specified time.
burst_buffer (optional)
String Burst buffer specification.
cluster_constraints (optional)
String Specifies features that a federated cluster must have to have a sibling job submitted to it.
comment (optional)
String An arbitrary comment.
constraints (optional)
String node features required by job.
core_specification (optional)
Integer Count of specialized threads per node reserved by the job for system operations and not used by the application.
cores_per_socket (optional)
Integer Restrict node selection to nodes with at least the specified number of cores per socket.
cpu_binding (optional)
String Cpu binding
cpu_binding_hint (optional)
String Cpu binding hint
cpu_frequency (optional)
String Request that job steps initiated by srun commands inside this sbatch script be run at some requested frequency if possible, on the CPUs selected for the step on the compute node(s).
cpus_per_gpu (optional)
String Number of CPUs requested per allocated GPU.
cpus_per_task (optional)
Integer Advise the Slurm controller that ensuing job steps will require ncpus number of processors per task.
current_working_directory (optional)
String Instruct Slurm to connect the batch script's standard output directly to the file name.
deadline (optional)
String Remove the job if no ending is possible before this deadline (start > (deadline - time[-min])).
delay_boot (optional)
Integer Do not reboot nodes in order to satisfied this job's feature specification if the job has been eligible to run for less than this time period.
dependency (optional)
String Defer the start of this job until the specified dependencies have been satisfied completed.
distribution (optional)
String Specify alternate distribution methods for remote processes.
environment (optional)
Object Dictionary of environment entries.
exclusive (optional)
String The job allocation can share nodes just other users with the "user" option or with the "mcs" option).
Enum:
user
mcs
true
false
get_user_environment (optional)
Boolean Load new login environment for user on job node.
gres (optional)
String Specifies a comma delimited list of generic consumable resources.
gres_flags (optional)
String Specify generic resource task binding options.
Enum:
disable-binding
enforce-binding
gpu_binding (optional)
String Requested binding of tasks to GPU.
gpu_frequency (optional)
String Requested GPU frequency.
gpus (optional)
String GPUs per job.
gpus_per_node (optional)
String GPUs per node.
gpus_per_socket (optional)
String GPUs per socket.
gpus_per_task (optional)
String GPUs per task.
hold (optional)
Boolean Specify the job is to be submitted in a held state (priority of zero).
kill_on_invalid_dependency (optional)
Boolean If a job has an invalid dependency, then Slurm is to terminate it.
licenses (optional)
String Specification of licenses (or other resources available on all nodes of the cluster) which must be allocated to this job.
mail_type (optional)
String Notify user by email when certain event types occur.
mail_user (optional)
String User to receive email notification of state changes as defined by mail_type.
mcs_label (optional)
String This parameter is a group among the groups of the user.
memory_binding (optional)
String Bind tasks to memory.
memory_per_cpu (optional)
Integer Minimum real memory per cpu (MB).
memory_per_gpu (optional)
Integer Minimum memory required per allocated GPU.
memory_per_node (optional)
Integer Minimum real memory per node (MB).
minimum_cpus_per_node (optional)
Integer Minimum number of CPUs per node.
minimum_nodes (optional)
Boolean If a range of node counts is given, prefer the smaller count.
name (optional)
String Specify a name for the job allocation.
nice (optional)
String Run the job with an adjusted scheduling priority within Slurm.
no_kill (optional)
Boolean Do not automatically terminate a job if one of the nodes it has been allocated fails.
nodes (optional)
array[Integer] Request that a minimum of minnodes nodes and a maximum node count.
open_mode (optional)
String Open the output and error files using append or truncate mode as specified.
Enum:
append
truncate
partition (optional)
String Request a specific partition for the resource allocation.
priority (optional)
String Request a specific job priority.
qos (optional)
String Request a quality of service for the job.
requeue (optional)
Boolean Specifies that the batch job should eligible to being requeue.
reservation (optional)
String Allocate resources for the job from the named reservation.
signal (optional)
String When a job is within sig_time seconds of its end time, send it the signal sig_num.
sockets_per_node (optional)
Integer Restrict node selection to nodes with at least the specified number of sockets.
spread_job (optional)
Boolean Spread the job allocation over as many nodes as possible and attempt to evenly distribute tasks across the allocated nodes.
standard_error (optional)
String Instruct Slurm to connect the batch script's standard error directly to the file name.
standard_in (optional)
String Instruct Slurm to connect the batch script's standard input directly to the file name specified.
standard_out (optional)
String Instruct Slurm to connect the batch script's standard output directly to the file name.
tasks (optional)
Integer Advises the Slurm controller that job steps run within the allocation will launch a maximum of number tasks and to provide for sufficient resources.
tasks_per_core (optional)
Integer Request the maximum ntasks be invoked on each core.
tasks_per_node (optional)
Integer Request the maximum ntasks be invoked on each node.
tasks_per_socket (optional)
Integer Request the maximum ntasks be invoked on each socket.
thread_specification (optional)
Integer Count of specialized threads per node reserved by the job for system operations and not used by the application.
threads_per_core (optional)
Integer Restrict node selection to nodes with at least the specified number of threads per core.
time_limit (optional)
Integer Step time limit.
time_minimum (optional)
Integer Minimum run time in minutes.
wait_all_nodes (optional)
Boolean Do not begin execution until all nodes are ready for use.
wckey (optional)
String Specify wckey to be used with job.
v0.0.36_job_resources - Up
nodes (optional)
String list of assigned job nodes
allocated_cpus (optional)
Integer number of assigned job cpus
allocated_hosts (optional)
Integer number of assigned job hosts
allocated_nodes (optional)
array[v0.0.36_node_allocation] node allocations
v0.0.36_job_response_properties - Up
account (optional)
String Charge resources used by this job to specified account
accrue_time (optional)
String time job is eligible for running
admin_comment (optional)
String administrator's arbitrary comment
array_job_id (optional)
String job_id of a job array or 0 if N/A
array_task_id (optional)
String task_id of a job array
array_max_tasks (optional)
String Maximum number of running array tasks
array_task_string (optional)
String string expression of task IDs in this record
association_id (optional)
String association id for job
batch_features (optional)
String features required for batch script's node
batch_flag (optional)
Boolean if batch: queued job with script
batch_host (optional)
String name of host running batch script
flags (optional)
array[String] Job flags
burst_buffer (optional)
String burst buffer specifications
burst_buffer_state (optional)
String burst buffer state info
cluster (optional)
String name of cluster that the job is on
cluster_features (optional)
String comma separated list of required cluster features
command (optional)
String command to be executed
comment (optional)
String arbitrary comment
contiguous (optional)
Boolean job requires contiguous nodes
core_spec (optional)
String specialized core count
thread_spec (optional)
String specialized thread count
cores_per_socket (optional)
String cores per socket required by job
billable_tres (optional)
String billable TRES
cpus_per_task (optional)
String number of processors required for each task
cpu_frequency_minimum (optional)
String Minimum cpu frequency
cpu_frequency_maximum (optional)
String Maximum cpu frequency
cpu_frequency_governor (optional)
String cpu frequency governor
cpus_per_tres (optional)
String semicolon delimited list of TRES=# values
deadline (optional)
String job start deadline
delay_boot (optional)
String command to be executed
dependency (optional)
String synchronize job execution with other jobs
derived_exit_code (optional)
String highest exit code of all job steps
eligible_time (optional)
String time job is eligible for running
end_time (optional)
String time of termination, actual or expected
excluded_nodes (optional)
String comma separated list of excluded nodes
exit_code (optional)
Integer exit code for job
features (optional)
String comma separated list of required features
federation_origin (optional)
String Origin cluster's name
federation_siblings_active (optional)
String string of active sibling names
federation_siblings_viable (optional)
String string of viable sibling names
gres_detail (optional)
array[String] Job flags
group_id (optional)
String group job submitted as
job_id (optional)
String job ID
job_resources (optional)
job_state (optional)
String state of the job
last_sched_evaluation (optional)
String last time job was evaluated for scheduling
licenses (optional)
String licenses required by the job
max_cpus (optional)
String maximum number of cpus usable by job
max_nodes (optional)
String maximum number of nodes usable by job
mcs_label (optional)
String mcs_label if mcs plugin in use
memory_per_tres (optional)
String semicolon delimited list of TRES=# values
name (optional)
String name of the job
nodes (optional)
String list of nodes allocated to job
nice (optional)
String requested priority change
tasks_per_core (optional)
String number of tasks to invoke on each core
tasks_per_socket (optional)
String number of tasks to invoke on each socket
tasks_per_board (optional)
String number of tasks to invoke on each board
cpus (optional)
String minimum number of cpus required by job
node_count (optional)
String minimum number of nodes required by job
tasks (optional)
String requested task count
het_job_id (optional)
String job ID of hetjob leader
het_job_id_set (optional)
String job IDs for all components
het_job_offset (optional)
String HetJob component offset from leader
partition (optional)
String name of assigned partition
memory_per_node (optional)
String minimum real memory per node
memory_per_cpu (optional)
String minimum real memory per cpu
minimum_cpus_per_node (optional)
String minimum # CPUs per node
minimum_tmp_disk_per_node (optional)
String minimum tmp disk per node
preempt_time (optional)
String preemption signal time
pre_sus_time (optional)
String time job ran prior to last suspend
priority (optional)
String relative priority of the job
profile (optional)
array[String] Job profiling requested
qos (optional)
String Quality of Service
reboot (optional)
Boolean node reboot requested before start
required_nodes (optional)
String comma separated list of required nodes
requeue (optional)
Boolean enable or disable job requeue option
resize_time (optional)
String time of latest size change
restart_cnt (optional)
String count of job restarts
resv_name (optional)
String reservation name
shared (optional)
String type and if job can share nodes with other jobs
show_flags (optional)
array[String] details requested
sockets_per_board (optional)
String sockets per board required by job
sockets_per_node (optional)
String sockets per node required by job
start_time (optional)
String time execution begins, actual or expected
state_description (optional)
String optional details for state_reason
state_reason (optional)
String reason job still pending or failed
standard_error (optional)
String pathname of job's stderr file
standard_input (optional)
String pathname of job's stdin file
standard_output (optional)
String pathname of job's stdout file
submit_time (optional)
String time of job submission
suspend_time (optional)
String time job last suspended or resumed
system_comment (optional)
String slurmctld's arbitrary comment
time_limit (optional)
String maximum run time in minutes
time_minimum (optional)
String minimum run time in minutes
threads_per_core (optional)
String threads per core required by job
tres_bind (optional)
String Task to TRES binding directives
tres_freq (optional)
String TRES frequency directives
tres_per_job (optional)
String semicolon delimited list of TRES=# values
tres_per_node (optional)
String semicolon delimited list of TRES=# values
tres_per_socket (optional)
String semicolon delimited list of TRES=# values
tres_per_task (optional)
String semicolon delimited list of TRES=# values
tres_req_str (optional)
String tres reqeusted in the job
tres_alloc_str (optional)
String tres used in the job
user_id (optional)
String user id the job runs as
user_name (optional)
String user the job runs as
wckey (optional)
String wckey for job
current_working_directory (optional)
String pathname of working directory
v0.0.36_job_submission - Up
script
String Executable script (full contents) to run in batch step
job (optional)
jobs (optional)
array[v0.0.36_job_properties] Properties of an HetJob
v0.0.36_job_submission_response - Up
errors (optional)
array[v0.0.36_error] slurm errors
job_id (optional)
Integer new job ID
step_id (optional)
String new job step ID
job_submit_user_msg (optional)
String Message to user from job_submit plugin
v0.0.36_jobs_response - Up
errors (optional)
array[v0.0.36_error] slurm errors
jobs (optional)
array[v0.0.36_job_response_properties] job descriptions
v0.0.36_node - Up
architecture (optional)
String computer architecture
burstbuffer_network_address (optional)
String BcastAddr
boards (optional)
Integer total number of boards per node
boot_time (optional)
Long timestamp of node boot format: int64
comment (optional)
String Arbitrary comment
cores (optional)
Integer number of cores per socket
cpu_binding (optional)
Integer Default task binding
cpu_load (optional)
Long CPU load * 100 format: int64
free_memory (optional)
Integer free memory in MiB
cpus (optional)
Integer configured count of cpus running on the node
features (optional)
active_features (optional)
String list of a node's available features
gres (optional)
String list of a node's generic resources
gres_drained (optional)
String list of drained GRES
gres_used (optional)
String list of GRES in current use
mcs_label (optional)
String mcs label if mcs plugin in use
name (optional)
String node name to slurm
next_state_after_reboot (optional)
address (optional)
String state after reboot
hostname (optional)
String node's hostname
state (optional)
String current node state
operating_system (optional)
String operating system
owner (optional)
String User allowed to use this node
port (optional)
Integer TCP port number of the slurmd
real_memory (optional)
Integer configured MB of real memory on the node
reason (optional)
String reason for node being DOWN or DRAINING
reason_changed_at (optional)
Integer Time stamp when reason was set
reason_set_by_user (optional)
String User that set the reason
slurmd_start_time (optional)
Long timestamp of slurmd startup format: int64
sockets (optional)
Integer total number of sockets per node
threads (optional)
Integer number of threads per core
temporary_disk (optional)
Integer configured MB of total disk in TMP_FS
weight (optional)
Integer arbitrary priority of node for scheduling
tres (optional)
String TRES on node
slurmd_version (optional)
String Slurmd version
v0.0.36_partition - Up
flags (optional)
array[String] partition options
preemption_mode (optional)
String preemption type
allowed_allocation_nodes (optional)
String list names of allowed allocating nodes
allowed_accounts (optional)
String comma delimited list of accounts
allowed_groups (optional)
String comma delimited list of groups
allowed_qos (optional)
String comma delimited list of qos
alternative (optional)
String name of alternate partition
billing_weights (optional)
String TRES billing weights
default_memory_per_cpu (optional)
Long default MB memory per allocated CPU format: int64
default_time_limit (optional)
Long default time limit (minutes) format: int64
denied_accounts (optional)
String comma delimited list of denied accounts
denied_qos (optional)
String comma delimited list of denied qos
preemption_grace_time (optional)
Long preemption grace time (seconds) format: int64
maximum_cpus_per_node (optional)
Integer maximum allocated CPUs per node
maximum_memory_per_node (optional)
Long maximum memory per allocated CPU (MiB) format: int64
maximum_nodes_per_job (optional)
Integer Max nodes per job
max_time_limit (optional)
Long Max time limit per job format: int64
min_nodes_per_job (optional)
Integer Min number of nodes per job
name (optional)
String Partition name
nodes (optional)
String list names of nodes in partition
over_time_limit (optional)
Integer job's time limit can be exceeded by this number of minutes before cancellation
priority_job_factor (optional)
Integer job priority weight factor
priority_tier (optional)
Integer tier for scheduling and preemption
qos (optional)
String partition QOS name
nodes_online (optional)
Integer Nodes online (ready for jobs)
total_cpus (optional)
Integer Total cpus in partition
total_nodes (optional)
Integer Total number of nodes in partition
tres (optional)
String configured TRES in partition
v0.0.36_partitions_response - Up
errors (optional)
array[v0.0.36_error] slurm errors
partitions (optional)
array[v0.0.36_partition] partition info
v0.0.36_pings - Up
errors (optional)
array[v0.0.36_error] slurm errors
pings (optional)
array[v0.0.36_ping] slurm controller pings
v0_0_36_diag_statistics - Up
Slurm statistics
parts_packed (optional)
Integer partition records packed
req_time (optional)
Integer generation time
req_time_start (optional)
Integer data since
server_thread_count (optional)
Integer Server thread count
agent_queue_size (optional)
Integer Agent queue size
agent_count (optional)
Integer Agent count
agent_thread_count (optional)
Integer Agent thread count
dbd_agent_queue_size (optional)
Integer DBD Agent queue size
gettimeofday_latency (optional)
Integer Latency for 1000 calls to gettimeofday()
schedule_cycle_max (optional)
Integer Main Schedule max cycle
schedule_cycle_last (optional)
Integer Main Schedule last cycle
schedule_cycle_total (optional)
Integer Main Schedule cycle iterations
schedule_cycle_mean (optional)
Integer Average time for Schedule Max cycle
schedule_cycle_mean_depth (optional)
Integer Average depth for Schedule Max cycle
schedule_cycle_per_minute (optional)
Integer Main Schedule Cycles per minute
schedule_queue_length (optional)
Integer Main Schedule Last queue length
jobs_submitted (optional)
Integer Job submitted
jobs_started (optional)
Integer Job started
jobs_completed (optional)
Integer Job completed
jobs_canceled (optional)
Integer Job cancelled
jobs_failed (optional)
Integer Job failed
jobs_pending (optional)
Integer Job pending
jobs_running (optional)
Integer Job running
job_states_ts (optional)
Integer Job states timestamp
bf_backfilled_jobs (optional)
Integer Total backfilled jobs (since last slurm start)
bf_last_backfilled_jobs (optional)
Integer Total backfilled jobs (since last stats cycle start)
bf_backfilled_het_jobs (optional)
Integer Total backfilled heterogeneous job components
bf_cycle_counter (optional)
Integer Backfill Schedule Total cycles
bf_cycle_mean (optional)
Integer Backfill Schedule Mean cycle
bf_cycle_max (optional)
Integer Backfill Schedule Max cycle time
bf_last_depth (optional)
Integer Backfill Schedule Last depth cycle
bf_last_depth_try (optional)
Integer Backfill Schedule Mean cycle (try sched)
bf_depth_mean (optional)
Integer Backfill Schedule Depth Mean
bf_depth_mean_try (optional)
Integer Backfill Schedule Depth Mean (try sched)
bf_cycle_last (optional)
Integer Backfill Schedule Last cycle time
bf_queue_len (optional)
Integer Backfill Schedule Last queue length
bf_queue_len_mean (optional)
Integer Backfill Schedule Mean queue length
bf_when_last_cycle (optional)
Integer Last cycle timestamp
bf_active (optional)
Boolean Backfill Schedule currently active