Slurm Rest API

API to access and control Slurm DB.
More information: https://www.schedmd.com/
Contact Info: sales@schedmd.com
Version: dbv0.0.39
BasePath:
Apache 2.0
https://www.apache.org/licenses/LICENSE-2.0.html

Access

  1. APIKey KeyParamName:X-SLURM-USER-NAME KeyInQuery:false KeyInHeader:true
  2. APIKey KeyParamName:X-SLURM-USER-TOKEN KeyInQuery:false KeyInHeader:true
  3. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Openapi

Slurm

Openapi

Up
get /openapi
Retrieve OpenAPI Specification (openapiGet)

Responses

200

OpenAPI Specification

Up
get /openapi.json
Retrieve OpenAPI Specification (openapiJsonGet)

Responses

200

OpenAPI Specification

Up
get /openapi/v3
Retrieve OpenAPI Specification (openapiV3Get)

Responses

200

OpenAPI Specification

Up
get /openapi.yaml
Retrieve OpenAPI Specification (openapiYamlGet)

Responses

200

OpenAPI Specification

Slurm

Up
delete /slurm/v0.0.39/job/{job_id}
cancel or signal job (slurmV0039CancelJob)

Path parameters

job_id (required)
Path Parameter — Slurm Job ID default: null

Query parameters

signal (optional)
Query Parameter — signal to send to job default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

job cancelled or sent signal status

default

Job cancel request failed status

Up
delete /slurm/v0.0.39/node/{node_name}
delete node (slurmV0039DeleteNode)

Path parameters

node_name (required)
Path Parameter — Slurm Node Name default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

node deleted status

default

node delete request failed status

Up
get /slurm/v0.0.39/diag
get diagnostics (slurmV0039Diag)

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ],
  "statistics" : {
    "schedule_cycle_per_minute" : 6,
    "req_time_start" : 5,
    "jobs_running" : 8,
    "bf_last_backfilled_jobs" : 3,
    "rpcs_by_message_type" : [ {
      "average_time" : 7,
      "type_id" : 3,
      "count" : 3,
      "message_type" : "message_type",
      "total_time" : 5
    }, {
      "average_time" : 7,
      "type_id" : 3,
      "count" : 3,
      "message_type" : "message_type",
      "total_time" : 5
    } ],
    "bf_last_depth" : 3,
    "bf_backfilled_het_jobs" : 6,
    "bf_backfilled_jobs" : 6,
    "rpcs_by_user" : [ {
      "average_time" : 0,
      "user_id" : 3,
      "count" : 4,
      "total_time" : 6,
      "user" : "user"
    }, {
      "average_time" : 0,
      "user_id" : 3,
      "count" : 4,
      "total_time" : 6,
      "user" : "user"
    } ],
    "bf_table_size" : 4,
    "bf_depth_sum" : 7,
    "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,
    "bf_table_size_mean" : 8,
    "jobs_pending" : 6,
    "agent_count" : 7,
    "bf_queue_len_sum" : 0,
    "bf_cycle_sum" : 5,
    "bf_cycle_last" : 6,
    "parts_packed" : 6,
    "agent_thread_count" : 9,
    "jobs_completed" : 5,
    "bf_depth_mean" : 6,
    "bf_active" : true,
    "bf_depth_mean_try" : 6,
    "bf_depth_try_sum" : 0,
    "schedule_cycle_mean" : 1,
    "agent_queue_size" : 2,
    "jobs_failed" : 9,
    "gettimeofday_latency" : 2,
    "bf_last_depth_try" : 3,
    "req_time" : 1,
    "bf_cycle_counter" : 1,
    "schedule_queue_length" : 7,
    "bf_queue_len_mean" : 6,
    "schedule_cycle_total" : 1,
    "bf_when_last_cycle" : 7,
    "schedule_cycle_last" : 7,
    "jobs_canceled" : 9,
    "jobs_submitted" : 1,
    "schedule_cycle_mean_depth" : 1
  }
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

diagnostic results v0.0.39_diag

default

unable to request ping test status

Up
get /slurm/v0.0.39/job/{job_id}
get job info (slurmV0039GetJob)

Path parameters

job_id (required)
Path Parameter — Slurm JobID default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "jobs" : [ {
    "container" : "container",
    "cluster" : "cluster",
    "time_minimum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "memory_per_tres" : "memory_per_tres",
    "scheduled_nodes" : "scheduled_nodes",
    "minimum_switches" : 9,
    "qos" : "qos",
    "resize_time" : 9,
    "eligible_time" : 9,
    "exclusive" : [ "true", "true" ],
    "cpus_per_tres" : "cpus_per_tres",
    "preemptable_time" : 4,
    "tasks" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "system_comment" : "system_comment",
    "federation_siblings_active" : "federation_siblings_active",
    "tasks_per_tres" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tasks_per_core" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "accrue_time" : 0,
    "dependency" : "dependency",
    "group_name" : "group_name",
    "profile" : [ "NOT_SET", "NOT_SET" ],
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "tres_per_job" : "tres_per_job",
    "failed_node" : "failed_node",
    "derived_exit_code" : 7,
    "maximum_switch_wait_time" : 1,
    "core_spec" : 1,
    "mcs_label" : "mcs_label",
    "required_nodes" : "required_nodes",
    "tres_bind" : "tres_bind",
    "user_id" : 6,
    "selinux_context" : "selinux_context",
    "exit_code" : 2,
    "federation_origin" : "federation_origin",
    "container_id" : "container_id",
    "shared" : [ "none", "none" ],
    "tasks_per_board" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "user_name" : "user_name",
    "flags" : [ "KILL_INVALID_DEPENDENCY", "KILL_INVALID_DEPENDENCY" ],
    "standard_input" : "standard_input",
    "admin_comment" : "admin_comment",
    "cores_per_socket" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "job_state" : "job_state",
    "tasks_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "current_working_directory" : "current_working_directory",
    "standard_error" : "standard_error",
    "array_job_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "cluster_features" : "cluster_features",
    "partition" : "partition",
    "threads_per_core" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tres_alloc_str" : "tres_alloc_str",
    "memory_per_cpu" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "cpu_frequency_minimum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "node_count" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "power" : {
      "flags" : [ "EQUAL_POWER", "EQUAL_POWER" ]
    },
    "deadline" : 2,
    "mail_type" : [ "BEGIN", "BEGIN" ],
    "memory_per_node" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "state_reason" : "state_reason",
    "het_job_offset" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "end_time" : 3,
    "sockets_per_board" : 8,
    "nice" : 7,
    "last_sched_evaluation" : 6,
    "tres_per_node" : "tres_per_node",
    "burst_buffer" : "burst_buffer",
    "licenses" : "licenses",
    "excluded_nodes" : "excluded_nodes",
    "array_max_tasks" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "het_job_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "sockets_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "prefer" : "prefer",
    "time_limit" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "minimum_cpus_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tasks_per_socket" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "batch_host" : "batch_host",
    "max_cpus" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "job_size_str" : [ "job_size_str", "job_size_str" ],
    "cpu_frequency_maximum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "features" : "features",
    "het_job_id_set" : "het_job_id_set",
    "state_description" : "state_description",
    "show_flags" : [ "ALL", "ALL" ],
    "array_task_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "minimum_tmp_disk_per_node" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "tres_req_str" : "tres_req_str",
    "burst_buffer_state" : "burst_buffer_state",
    "cron" : "cron",
    "allocating_node" : "allocating_node",
    "tres_per_socket" : "tres_per_socket",
    "array_task_string" : "array_task_string",
    "submit_time" : 6,
    "wckey" : "wckey",
    "max_nodes" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "batch_flag" : true,
    "start_time" : 9,
    "name" : "name",
    "preempt_time" : 1,
    "contiguous" : true,
    "job_resources" : {
      "nodes" : "nodes",
      "allocated_nodes" : [ "", "" ],
      "allocated_cpus" : 1,
      "allocated_hosts" : 1,
      "allocated_cores" : 1
    },
    "billable_tres" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "federation_siblings_viable" : "federation_siblings_viable",
    "cpus_per_task" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "batch_features" : "batch_features",
    "thread_spec" : 5,
    "cpu_frequency_governor" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "gres_detail" : [ "gres_detail", "gres_detail" ],
    "network" : "network",
    "restart_cnt" : 6,
    "resv_name" : "resv_name",
    "extra" : "extra",
    "delay_boot" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "reboot" : true,
    "cpus" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "standard_output" : "standard_output",
    "pre_sus_time" : 5,
    "suspend_time" : 3,
    "association_id" : 6,
    "command" : "command",
    "tres_freq" : "tres_freq",
    "requeue" : true,
    "tres_per_task" : "tres_per_task",
    "mail_user" : "mail_user",
    "nodes" : "nodes",
    "group_id" : 4,
    "job_id" : 7,
    "comment" : "comment",
    "account" : "account"
  }, {
    "container" : "container",
    "cluster" : "cluster",
    "time_minimum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "memory_per_tres" : "memory_per_tres",
    "scheduled_nodes" : "scheduled_nodes",
    "minimum_switches" : 9,
    "qos" : "qos",
    "resize_time" : 9,
    "eligible_time" : 9,
    "exclusive" : [ "true", "true" ],
    "cpus_per_tres" : "cpus_per_tres",
    "preemptable_time" : 4,
    "tasks" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "system_comment" : "system_comment",
    "federation_siblings_active" : "federation_siblings_active",
    "tasks_per_tres" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tasks_per_core" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "accrue_time" : 0,
    "dependency" : "dependency",
    "group_name" : "group_name",
    "profile" : [ "NOT_SET", "NOT_SET" ],
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "tres_per_job" : "tres_per_job",
    "failed_node" : "failed_node",
    "derived_exit_code" : 7,
    "maximum_switch_wait_time" : 1,
    "core_spec" : 1,
    "mcs_label" : "mcs_label",
    "required_nodes" : "required_nodes",
    "tres_bind" : "tres_bind",
    "user_id" : 6,
    "selinux_context" : "selinux_context",
    "exit_code" : 2,
    "federation_origin" : "federation_origin",
    "container_id" : "container_id",
    "shared" : [ "none", "none" ],
    "tasks_per_board" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "user_name" : "user_name",
    "flags" : [ "KILL_INVALID_DEPENDENCY", "KILL_INVALID_DEPENDENCY" ],
    "standard_input" : "standard_input",
    "admin_comment" : "admin_comment",
    "cores_per_socket" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "job_state" : "job_state",
    "tasks_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "current_working_directory" : "current_working_directory",
    "standard_error" : "standard_error",
    "array_job_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "cluster_features" : "cluster_features",
    "partition" : "partition",
    "threads_per_core" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tres_alloc_str" : "tres_alloc_str",
    "memory_per_cpu" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "cpu_frequency_minimum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "node_count" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "power" : {
      "flags" : [ "EQUAL_POWER", "EQUAL_POWER" ]
    },
    "deadline" : 2,
    "mail_type" : [ "BEGIN", "BEGIN" ],
    "memory_per_node" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "state_reason" : "state_reason",
    "het_job_offset" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "end_time" : 3,
    "sockets_per_board" : 8,
    "nice" : 7,
    "last_sched_evaluation" : 6,
    "tres_per_node" : "tres_per_node",
    "burst_buffer" : "burst_buffer",
    "licenses" : "licenses",
    "excluded_nodes" : "excluded_nodes",
    "array_max_tasks" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "het_job_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "sockets_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "prefer" : "prefer",
    "time_limit" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "minimum_cpus_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tasks_per_socket" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "batch_host" : "batch_host",
    "max_cpus" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "job_size_str" : [ "job_size_str", "job_size_str" ],
    "cpu_frequency_maximum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "features" : "features",
    "het_job_id_set" : "het_job_id_set",
    "state_description" : "state_description",
    "show_flags" : [ "ALL", "ALL" ],
    "array_task_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "minimum_tmp_disk_per_node" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "tres_req_str" : "tres_req_str",
    "burst_buffer_state" : "burst_buffer_state",
    "cron" : "cron",
    "allocating_node" : "allocating_node",
    "tres_per_socket" : "tres_per_socket",
    "array_task_string" : "array_task_string",
    "submit_time" : 6,
    "wckey" : "wckey",
    "max_nodes" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "batch_flag" : true,
    "start_time" : 9,
    "name" : "name",
    "preempt_time" : 1,
    "contiguous" : true,
    "job_resources" : {
      "nodes" : "nodes",
      "allocated_nodes" : [ "", "" ],
      "allocated_cpus" : 1,
      "allocated_hosts" : 1,
      "allocated_cores" : 1
    },
    "billable_tres" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "federation_siblings_viable" : "federation_siblings_viable",
    "cpus_per_task" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "batch_features" : "batch_features",
    "thread_spec" : 5,
    "cpu_frequency_governor" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "gres_detail" : [ "gres_detail", "gres_detail" ],
    "network" : "network",
    "restart_cnt" : 6,
    "resv_name" : "resv_name",
    "extra" : "extra",
    "delay_boot" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "reboot" : true,
    "cpus" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "standard_output" : "standard_output",
    "pre_sus_time" : 5,
    "suspend_time" : 3,
    "association_id" : 6,
    "command" : "command",
    "tres_freq" : "tres_freq",
    "requeue" : true,
    "tres_per_task" : "tres_per_task",
    "mail_user" : "mail_user",
    "nodes" : "nodes",
    "group_id" : 4,
    "job_id" : 7,
    "comment" : "comment",
    "account" : "account"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

job(s) information v0.0.39_jobs_response

default

job matching JobId not found

Up
get /slurm/v0.0.39/jobs
get list of jobs (slurmV0039GetJobs)

Query parameters

update_time (optional)
Query Parameter — Filter if changed since update_time. Use of this parameter can result in faster replies. default: null format: int64

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "jobs" : [ {
    "container" : "container",
    "cluster" : "cluster",
    "time_minimum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "memory_per_tres" : "memory_per_tres",
    "scheduled_nodes" : "scheduled_nodes",
    "minimum_switches" : 9,
    "qos" : "qos",
    "resize_time" : 9,
    "eligible_time" : 9,
    "exclusive" : [ "true", "true" ],
    "cpus_per_tres" : "cpus_per_tres",
    "preemptable_time" : 4,
    "tasks" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "system_comment" : "system_comment",
    "federation_siblings_active" : "federation_siblings_active",
    "tasks_per_tres" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tasks_per_core" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "accrue_time" : 0,
    "dependency" : "dependency",
    "group_name" : "group_name",
    "profile" : [ "NOT_SET", "NOT_SET" ],
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "tres_per_job" : "tres_per_job",
    "failed_node" : "failed_node",
    "derived_exit_code" : 7,
    "maximum_switch_wait_time" : 1,
    "core_spec" : 1,
    "mcs_label" : "mcs_label",
    "required_nodes" : "required_nodes",
    "tres_bind" : "tres_bind",
    "user_id" : 6,
    "selinux_context" : "selinux_context",
    "exit_code" : 2,
    "federation_origin" : "federation_origin",
    "container_id" : "container_id",
    "shared" : [ "none", "none" ],
    "tasks_per_board" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "user_name" : "user_name",
    "flags" : [ "KILL_INVALID_DEPENDENCY", "KILL_INVALID_DEPENDENCY" ],
    "standard_input" : "standard_input",
    "admin_comment" : "admin_comment",
    "cores_per_socket" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "job_state" : "job_state",
    "tasks_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "current_working_directory" : "current_working_directory",
    "standard_error" : "standard_error",
    "array_job_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "cluster_features" : "cluster_features",
    "partition" : "partition",
    "threads_per_core" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tres_alloc_str" : "tres_alloc_str",
    "memory_per_cpu" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "cpu_frequency_minimum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "node_count" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "power" : {
      "flags" : [ "EQUAL_POWER", "EQUAL_POWER" ]
    },
    "deadline" : 2,
    "mail_type" : [ "BEGIN", "BEGIN" ],
    "memory_per_node" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "state_reason" : "state_reason",
    "het_job_offset" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "end_time" : 3,
    "sockets_per_board" : 8,
    "nice" : 7,
    "last_sched_evaluation" : 6,
    "tres_per_node" : "tres_per_node",
    "burst_buffer" : "burst_buffer",
    "licenses" : "licenses",
    "excluded_nodes" : "excluded_nodes",
    "array_max_tasks" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "het_job_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "sockets_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "prefer" : "prefer",
    "time_limit" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "minimum_cpus_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tasks_per_socket" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "batch_host" : "batch_host",
    "max_cpus" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "job_size_str" : [ "job_size_str", "job_size_str" ],
    "cpu_frequency_maximum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "features" : "features",
    "het_job_id_set" : "het_job_id_set",
    "state_description" : "state_description",
    "show_flags" : [ "ALL", "ALL" ],
    "array_task_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "minimum_tmp_disk_per_node" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "tres_req_str" : "tres_req_str",
    "burst_buffer_state" : "burst_buffer_state",
    "cron" : "cron",
    "allocating_node" : "allocating_node",
    "tres_per_socket" : "tres_per_socket",
    "array_task_string" : "array_task_string",
    "submit_time" : 6,
    "wckey" : "wckey",
    "max_nodes" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "batch_flag" : true,
    "start_time" : 9,
    "name" : "name",
    "preempt_time" : 1,
    "contiguous" : true,
    "job_resources" : {
      "nodes" : "nodes",
      "allocated_nodes" : [ "", "" ],
      "allocated_cpus" : 1,
      "allocated_hosts" : 1,
      "allocated_cores" : 1
    },
    "billable_tres" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "federation_siblings_viable" : "federation_siblings_viable",
    "cpus_per_task" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "batch_features" : "batch_features",
    "thread_spec" : 5,
    "cpu_frequency_governor" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "gres_detail" : [ "gres_detail", "gres_detail" ],
    "network" : "network",
    "restart_cnt" : 6,
    "resv_name" : "resv_name",
    "extra" : "extra",
    "delay_boot" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "reboot" : true,
    "cpus" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "standard_output" : "standard_output",
    "pre_sus_time" : 5,
    "suspend_time" : 3,
    "association_id" : 6,
    "command" : "command",
    "tres_freq" : "tres_freq",
    "requeue" : true,
    "tres_per_task" : "tres_per_task",
    "mail_user" : "mail_user",
    "nodes" : "nodes",
    "group_id" : 4,
    "job_id" : 7,
    "comment" : "comment",
    "account" : "account"
  }, {
    "container" : "container",
    "cluster" : "cluster",
    "time_minimum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "memory_per_tres" : "memory_per_tres",
    "scheduled_nodes" : "scheduled_nodes",
    "minimum_switches" : 9,
    "qos" : "qos",
    "resize_time" : 9,
    "eligible_time" : 9,
    "exclusive" : [ "true", "true" ],
    "cpus_per_tres" : "cpus_per_tres",
    "preemptable_time" : 4,
    "tasks" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "system_comment" : "system_comment",
    "federation_siblings_active" : "federation_siblings_active",
    "tasks_per_tres" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tasks_per_core" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "accrue_time" : 0,
    "dependency" : "dependency",
    "group_name" : "group_name",
    "profile" : [ "NOT_SET", "NOT_SET" ],
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "tres_per_job" : "tres_per_job",
    "failed_node" : "failed_node",
    "derived_exit_code" : 7,
    "maximum_switch_wait_time" : 1,
    "core_spec" : 1,
    "mcs_label" : "mcs_label",
    "required_nodes" : "required_nodes",
    "tres_bind" : "tres_bind",
    "user_id" : 6,
    "selinux_context" : "selinux_context",
    "exit_code" : 2,
    "federation_origin" : "federation_origin",
    "container_id" : "container_id",
    "shared" : [ "none", "none" ],
    "tasks_per_board" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "user_name" : "user_name",
    "flags" : [ "KILL_INVALID_DEPENDENCY", "KILL_INVALID_DEPENDENCY" ],
    "standard_input" : "standard_input",
    "admin_comment" : "admin_comment",
    "cores_per_socket" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "job_state" : "job_state",
    "tasks_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "current_working_directory" : "current_working_directory",
    "standard_error" : "standard_error",
    "array_job_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "cluster_features" : "cluster_features",
    "partition" : "partition",
    "threads_per_core" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tres_alloc_str" : "tres_alloc_str",
    "memory_per_cpu" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "cpu_frequency_minimum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "node_count" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "power" : {
      "flags" : [ "EQUAL_POWER", "EQUAL_POWER" ]
    },
    "deadline" : 2,
    "mail_type" : [ "BEGIN", "BEGIN" ],
    "memory_per_node" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "state_reason" : "state_reason",
    "het_job_offset" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "end_time" : 3,
    "sockets_per_board" : 8,
    "nice" : 7,
    "last_sched_evaluation" : 6,
    "tres_per_node" : "tres_per_node",
    "burst_buffer" : "burst_buffer",
    "licenses" : "licenses",
    "excluded_nodes" : "excluded_nodes",
    "array_max_tasks" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "het_job_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "sockets_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "prefer" : "prefer",
    "time_limit" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "minimum_cpus_per_node" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "tasks_per_socket" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "batch_host" : "batch_host",
    "max_cpus" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "job_size_str" : [ "job_size_str", "job_size_str" ],
    "cpu_frequency_maximum" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "features" : "features",
    "het_job_id_set" : "het_job_id_set",
    "state_description" : "state_description",
    "show_flags" : [ "ALL", "ALL" ],
    "array_task_id" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "minimum_tmp_disk_per_node" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "tres_req_str" : "tres_req_str",
    "burst_buffer_state" : "burst_buffer_state",
    "cron" : "cron",
    "allocating_node" : "allocating_node",
    "tres_per_socket" : "tres_per_socket",
    "array_task_string" : "array_task_string",
    "submit_time" : 6,
    "wckey" : "wckey",
    "max_nodes" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "batch_flag" : true,
    "start_time" : 9,
    "name" : "name",
    "preempt_time" : 1,
    "contiguous" : true,
    "job_resources" : {
      "nodes" : "nodes",
      "allocated_nodes" : [ "", "" ],
      "allocated_cpus" : 1,
      "allocated_hosts" : 1,
      "allocated_cores" : 1
    },
    "billable_tres" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "federation_siblings_viable" : "federation_siblings_viable",
    "cpus_per_task" : {
      "number" : 5,
      "set" : false,
      "infinite" : true
    },
    "batch_features" : "batch_features",
    "thread_spec" : 5,
    "cpu_frequency_governor" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "gres_detail" : [ "gres_detail", "gres_detail" ],
    "network" : "network",
    "restart_cnt" : 6,
    "resv_name" : "resv_name",
    "extra" : "extra",
    "delay_boot" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "reboot" : true,
    "cpus" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "standard_output" : "standard_output",
    "pre_sus_time" : 5,
    "suspend_time" : 3,
    "association_id" : 6,
    "command" : "command",
    "tres_freq" : "tres_freq",
    "requeue" : true,
    "tres_per_task" : "tres_per_task",
    "mail_user" : "mail_user",
    "nodes" : "nodes",
    "group_id" : 4,
    "job_id" : 7,
    "comment" : "comment",
    "account" : "account"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

job(s) information v0.0.39_jobs_response

default

job not found status

Up
get /slurm/v0.0.39/node/{node_name}
get node info (slurmV0039GetNode)

Path parameters

node_name (required)
Path Parameter — Slurm Node Name default: null

Return type

Example data

Content-Type: application/json
{
  "nodes" : [ {
    "reason" : "reason",
    "slurmd_start_time" : 5,
    "features" : [ "features", "features" ],
    "hostname" : "hostname",
    "cores" : 1,
    "reason_changed_at" : 6,
    "reservation" : "reservation",
    "tres" : "tres",
    "cpu_binding" : 5,
    "state" : [ "INVALID", "INVALID" ],
    "sockets" : 6,
    "energy" : {
      "current_watts" : 4,
      "base_consumed_energy" : 3,
      "last_collected" : 1,
      "consumed_energy" : 2,
      "previous_consumed_energy" : 7,
      "average_watts" : 9
    },
    "partitions" : [ "partitions", "partitions" ],
    "gres_drained" : "gres_drained",
    "weight" : 7,
    "version" : "version",
    "gres_used" : "gres_used",
    "mcs_label" : "mcs_label",
    "real_memory" : 3,
    "burstbuffer_network_address" : "burstbuffer_network_address",
    "port" : 6,
    "name" : "name",
    "resume_after" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "temporary_disk" : 3,
    "tres_used" : "tres_used",
    "effective_cpus" : 7,
    "external_sensors" : {
      "current_watts" : 1,
      "temperature" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      },
      "energy_update_time" : 1,
      "consumed_energy" : {
        "number" : 1,
        "set" : false,
        "infinite" : true
      }
    },
    "boards" : 0,
    "alloc_cpus" : 2,
    "active_features" : [ "active_features", "active_features" ],
    "reason_set_by_user" : "reason_set_by_user",
    "free_mem" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "alloc_idle_cpus" : 6,
    "extra" : "extra",
    "operating_system" : "operating_system",
    "power" : {
      "current_watts" : 6,
      "total_energy" : 7,
      "lowest_watts" : 5,
      "new_maximum_watts" : 1,
      "new_job_time" : 9,
      "state" : 9,
      "time_start_day" : 6,
      "peak_watts" : 4,
      "maximum_watts" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "architecture" : "architecture",
    "owner" : "owner",
    "cluster_name" : "cluster_name",
    "address" : "address",
    "cpus" : 2,
    "tres_weighted" : 6.878052220127876,
    "gres" : "gres",
    "threads" : 3,
    "boot_time" : 6,
    "alloc_memory" : 1,
    "specialized_memory" : 9,
    "specialized_cpus" : "specialized_cpus",
    "specialized_cores" : 5,
    "last_busy" : 8,
    "comment" : "comment",
    "next_state_after_reboot" : [ "INVALID", "INVALID" ],
    "cpu_load" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    }
  }, {
    "reason" : "reason",
    "slurmd_start_time" : 5,
    "features" : [ "features", "features" ],
    "hostname" : "hostname",
    "cores" : 1,
    "reason_changed_at" : 6,
    "reservation" : "reservation",
    "tres" : "tres",
    "cpu_binding" : 5,
    "state" : [ "INVALID", "INVALID" ],
    "sockets" : 6,
    "energy" : {
      "current_watts" : 4,
      "base_consumed_energy" : 3,
      "last_collected" : 1,
      "consumed_energy" : 2,
      "previous_consumed_energy" : 7,
      "average_watts" : 9
    },
    "partitions" : [ "partitions", "partitions" ],
    "gres_drained" : "gres_drained",
    "weight" : 7,
    "version" : "version",
    "gres_used" : "gres_used",
    "mcs_label" : "mcs_label",
    "real_memory" : 3,
    "burstbuffer_network_address" : "burstbuffer_network_address",
    "port" : 6,
    "name" : "name",
    "resume_after" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "temporary_disk" : 3,
    "tres_used" : "tres_used",
    "effective_cpus" : 7,
    "external_sensors" : {
      "current_watts" : 1,
      "temperature" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      },
      "energy_update_time" : 1,
      "consumed_energy" : {
        "number" : 1,
        "set" : false,
        "infinite" : true
      }
    },
    "boards" : 0,
    "alloc_cpus" : 2,
    "active_features" : [ "active_features", "active_features" ],
    "reason_set_by_user" : "reason_set_by_user",
    "free_mem" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "alloc_idle_cpus" : 6,
    "extra" : "extra",
    "operating_system" : "operating_system",
    "power" : {
      "current_watts" : 6,
      "total_energy" : 7,
      "lowest_watts" : 5,
      "new_maximum_watts" : 1,
      "new_job_time" : 9,
      "state" : 9,
      "time_start_day" : 6,
      "peak_watts" : 4,
      "maximum_watts" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "architecture" : "architecture",
    "owner" : "owner",
    "cluster_name" : "cluster_name",
    "address" : "address",
    "cpus" : 2,
    "tres_weighted" : 6.878052220127876,
    "gres" : "gres",
    "threads" : 3,
    "boot_time" : 6,
    "alloc_memory" : 1,
    "specialized_memory" : 9,
    "specialized_cpus" : "specialized_cpus",
    "specialized_cores" : 5,
    "last_busy" : 8,
    "comment" : "comment",
    "next_state_after_reboot" : [ "INVALID", "INVALID" ],
    "cpu_load" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    }
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

node information v0.0.39_nodes_response

default

node not found status

Up
get /slurm/v0.0.39/nodes
get all node info (slurmV0039GetNodes)

Query parameters

update_time (optional)
Query Parameter — Filter if changed since update_time. Use of this parameter can result in faster replies. default: null format: int64

Return type

Example data

Content-Type: application/json
{
  "nodes" : [ {
    "reason" : "reason",
    "slurmd_start_time" : 5,
    "features" : [ "features", "features" ],
    "hostname" : "hostname",
    "cores" : 1,
    "reason_changed_at" : 6,
    "reservation" : "reservation",
    "tres" : "tres",
    "cpu_binding" : 5,
    "state" : [ "INVALID", "INVALID" ],
    "sockets" : 6,
    "energy" : {
      "current_watts" : 4,
      "base_consumed_energy" : 3,
      "last_collected" : 1,
      "consumed_energy" : 2,
      "previous_consumed_energy" : 7,
      "average_watts" : 9
    },
    "partitions" : [ "partitions", "partitions" ],
    "gres_drained" : "gres_drained",
    "weight" : 7,
    "version" : "version",
    "gres_used" : "gres_used",
    "mcs_label" : "mcs_label",
    "real_memory" : 3,
    "burstbuffer_network_address" : "burstbuffer_network_address",
    "port" : 6,
    "name" : "name",
    "resume_after" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "temporary_disk" : 3,
    "tres_used" : "tres_used",
    "effective_cpus" : 7,
    "external_sensors" : {
      "current_watts" : 1,
      "temperature" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      },
      "energy_update_time" : 1,
      "consumed_energy" : {
        "number" : 1,
        "set" : false,
        "infinite" : true
      }
    },
    "boards" : 0,
    "alloc_cpus" : 2,
    "active_features" : [ "active_features", "active_features" ],
    "reason_set_by_user" : "reason_set_by_user",
    "free_mem" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "alloc_idle_cpus" : 6,
    "extra" : "extra",
    "operating_system" : "operating_system",
    "power" : {
      "current_watts" : 6,
      "total_energy" : 7,
      "lowest_watts" : 5,
      "new_maximum_watts" : 1,
      "new_job_time" : 9,
      "state" : 9,
      "time_start_day" : 6,
      "peak_watts" : 4,
      "maximum_watts" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "architecture" : "architecture",
    "owner" : "owner",
    "cluster_name" : "cluster_name",
    "address" : "address",
    "cpus" : 2,
    "tres_weighted" : 6.878052220127876,
    "gres" : "gres",
    "threads" : 3,
    "boot_time" : 6,
    "alloc_memory" : 1,
    "specialized_memory" : 9,
    "specialized_cpus" : "specialized_cpus",
    "specialized_cores" : 5,
    "last_busy" : 8,
    "comment" : "comment",
    "next_state_after_reboot" : [ "INVALID", "INVALID" ],
    "cpu_load" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    }
  }, {
    "reason" : "reason",
    "slurmd_start_time" : 5,
    "features" : [ "features", "features" ],
    "hostname" : "hostname",
    "cores" : 1,
    "reason_changed_at" : 6,
    "reservation" : "reservation",
    "tres" : "tres",
    "cpu_binding" : 5,
    "state" : [ "INVALID", "INVALID" ],
    "sockets" : 6,
    "energy" : {
      "current_watts" : 4,
      "base_consumed_energy" : 3,
      "last_collected" : 1,
      "consumed_energy" : 2,
      "previous_consumed_energy" : 7,
      "average_watts" : 9
    },
    "partitions" : [ "partitions", "partitions" ],
    "gres_drained" : "gres_drained",
    "weight" : 7,
    "version" : "version",
    "gres_used" : "gres_used",
    "mcs_label" : "mcs_label",
    "real_memory" : 3,
    "burstbuffer_network_address" : "burstbuffer_network_address",
    "port" : 6,
    "name" : "name",
    "resume_after" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "temporary_disk" : 3,
    "tres_used" : "tres_used",
    "effective_cpus" : 7,
    "external_sensors" : {
      "current_watts" : 1,
      "temperature" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      },
      "energy_update_time" : 1,
      "consumed_energy" : {
        "number" : 1,
        "set" : false,
        "infinite" : true
      }
    },
    "boards" : 0,
    "alloc_cpus" : 2,
    "active_features" : [ "active_features", "active_features" ],
    "reason_set_by_user" : "reason_set_by_user",
    "free_mem" : {
      "number" : 1,
      "set" : false,
      "infinite" : true
    },
    "alloc_idle_cpus" : 6,
    "extra" : "extra",
    "operating_system" : "operating_system",
    "power" : {
      "current_watts" : 6,
      "total_energy" : 7,
      "lowest_watts" : 5,
      "new_maximum_watts" : 1,
      "new_job_time" : 9,
      "state" : 9,
      "time_start_day" : 6,
      "peak_watts" : 4,
      "maximum_watts" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "architecture" : "architecture",
    "owner" : "owner",
    "cluster_name" : "cluster_name",
    "address" : "address",
    "cpus" : 2,
    "tres_weighted" : 6.878052220127876,
    "gres" : "gres",
    "threads" : 3,
    "boot_time" : 6,
    "alloc_memory" : 1,
    "specialized_memory" : 9,
    "specialized_cpus" : "specialized_cpus",
    "specialized_cores" : 5,
    "last_busy" : 8,
    "comment" : "comment",
    "next_state_after_reboot" : [ "INVALID", "INVALID" ],
    "cpu_load" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    }
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

node information v0.0.39_nodes_response

default

no nodes in cluster status

Up
get /slurm/v0.0.39/partition/{partition_name}
get partition info (slurmV0039GetPartition)

Path parameters

partition_name (required)
Path Parameter — Slurm Partition Name default: null

Query parameters

update_time (optional)
Query Parameter — Filter if there were no partition changes (not limited to partition in URL endpoint) since update_time. default: null format: int64

Return type

Example data

Content-Type: application/json
{
  "partitions" : [ {
    "cluster" : "cluster",
    "cpus" : {
      "total" : 0
    },
    "timeouts" : {
      "suspend" : {
        "number" : 5,
        "set" : false,
        "infinite" : true
      }
    },
    "groups" : {
      "allowed" : "allowed"
    },
    "alternate" : "alternate",
    "suspend_time" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "priority" : {
      "tier" : 5
    },
    "node_sets" : "node_sets",
    "maximums" : {
      "over_time_limit" : {
        "number" : 5,
        "set" : false,
        "infinite" : true
      }
    },
    "nodes" : {
      "total" : 0
    },
    "qos" : {
      "assigned" : "assigned"
    },
    "defaults" : {
      "job" : "job"
    },
    "name" : "name",
    "tres" : {
      "configured" : "configured"
    },
    "accounts" : {
      "deny" : "deny"
    },
    "minimums" : {
      "nodes" : 1
    },
    "grace_time" : 6
  }, {
    "cluster" : "cluster",
    "cpus" : {
      "total" : 0
    },
    "timeouts" : {
      "suspend" : {
        "number" : 5,
        "set" : false,
        "infinite" : true
      }
    },
    "groups" : {
      "allowed" : "allowed"
    },
    "alternate" : "alternate",
    "suspend_time" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "priority" : {
      "tier" : 5
    },
    "node_sets" : "node_sets",
    "maximums" : {
      "over_time_limit" : {
        "number" : 5,
        "set" : false,
        "infinite" : true
      }
    },
    "nodes" : {
      "total" : 0
    },
    "qos" : {
      "assigned" : "assigned"
    },
    "defaults" : {
      "job" : "job"
    },
    "name" : "name",
    "tres" : {
      "configured" : "configured"
    },
    "accounts" : {
      "deny" : "deny"
    },
    "minimums" : {
      "nodes" : 1
    },
    "grace_time" : 6
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

partition information v0.0.39_partitions_response

default

no partitions found status

Up
get /slurm/v0.0.39/partitions
get all partition info (slurmV0039GetPartitions)

Query parameters

update_time (optional)
Query Parameter — Filter if changed since update_time. Use of this parameter can result in faster replies. default: null format: int64

Return type

Example data

Content-Type: application/json
{
  "partitions" : [ {
    "cluster" : "cluster",
    "cpus" : {
      "total" : 0
    },
    "timeouts" : {
      "suspend" : {
        "number" : 5,
        "set" : false,
        "infinite" : true
      }
    },
    "groups" : {
      "allowed" : "allowed"
    },
    "alternate" : "alternate",
    "suspend_time" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "priority" : {
      "tier" : 5
    },
    "node_sets" : "node_sets",
    "maximums" : {
      "over_time_limit" : {
        "number" : 5,
        "set" : false,
        "infinite" : true
      }
    },
    "nodes" : {
      "total" : 0
    },
    "qos" : {
      "assigned" : "assigned"
    },
    "defaults" : {
      "job" : "job"
    },
    "name" : "name",
    "tres" : {
      "configured" : "configured"
    },
    "accounts" : {
      "deny" : "deny"
    },
    "minimums" : {
      "nodes" : 1
    },
    "grace_time" : 6
  }, {
    "cluster" : "cluster",
    "cpus" : {
      "total" : 0
    },
    "timeouts" : {
      "suspend" : {
        "number" : 5,
        "set" : false,
        "infinite" : true
      }
    },
    "groups" : {
      "allowed" : "allowed"
    },
    "alternate" : "alternate",
    "suspend_time" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "priority" : {
      "tier" : 5
    },
    "node_sets" : "node_sets",
    "maximums" : {
      "over_time_limit" : {
        "number" : 5,
        "set" : false,
        "infinite" : true
      }
    },
    "nodes" : {
      "total" : 0
    },
    "qos" : {
      "assigned" : "assigned"
    },
    "defaults" : {
      "job" : "job"
    },
    "name" : "name",
    "tres" : {
      "configured" : "configured"
    },
    "accounts" : {
      "deny" : "deny"
    },
    "minimums" : {
      "nodes" : 1
    },
    "grace_time" : 6
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

partition information v0.0.39_partitions_response

default

no partitions found status

Up
get /slurm/v0.0.39/reservation/{reservation_name}
get reservation info (slurmV0039GetReservation)

Path parameters

reservation_name (required)
Path Parameter — Slurm Reservation Name default: null

Query parameters

update_time (optional)
Query Parameter — Filter if no reservation (not limited to reservation in URL) changed since update_time. default: null format: int64

Return type

Example data

Content-Type: application/json
{
  "reservations" : [ {
    "end_time" : 6,
    "flags" : [ "MAINT", "MAINT" ],
    "groups" : "groups",
    "users" : "users",
    "max_start_delay" : 1,
    "features" : "features",
    "start_time" : 5,
    "burst_buffer" : "burst_buffer",
    "licenses" : "licenses",
    "partition" : "partition",
    "watts" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "core_specializations" : [ {
      "node" : "node",
      "core" : "core"
    }, {
      "node" : "node",
      "core" : "core"
    } ],
    "name" : "name",
    "tres" : "tres",
    "accounts" : "accounts",
    "node_count" : 5,
    "node_list" : "node_list",
    "purge_completed" : {
      "time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "core_count" : 0
  }, {
    "end_time" : 6,
    "flags" : [ "MAINT", "MAINT" ],
    "groups" : "groups",
    "users" : "users",
    "max_start_delay" : 1,
    "features" : "features",
    "start_time" : 5,
    "burst_buffer" : "burst_buffer",
    "licenses" : "licenses",
    "partition" : "partition",
    "watts" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "core_specializations" : [ {
      "node" : "node",
      "core" : "core"
    }, {
      "node" : "node",
      "core" : "core"
    } ],
    "name" : "name",
    "tres" : "tres",
    "accounts" : "accounts",
    "node_count" : 5,
    "node_list" : "node_list",
    "purge_completed" : {
      "time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "core_count" : 0
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

reservation information v0.0.39_reservations_response

default

no reservations found status

Up
get /slurm/v0.0.39/reservations
get all reservation info (slurmV0039GetReservations)

Query parameters

update_time (optional)
Query Parameter — Filter if changed since update_time. Use of this parameter can result in faster replies. default: null format: int64

Return type

Example data

Content-Type: application/json
{
  "reservations" : [ {
    "end_time" : 6,
    "flags" : [ "MAINT", "MAINT" ],
    "groups" : "groups",
    "users" : "users",
    "max_start_delay" : 1,
    "features" : "features",
    "start_time" : 5,
    "burst_buffer" : "burst_buffer",
    "licenses" : "licenses",
    "partition" : "partition",
    "watts" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "core_specializations" : [ {
      "node" : "node",
      "core" : "core"
    }, {
      "node" : "node",
      "core" : "core"
    } ],
    "name" : "name",
    "tres" : "tres",
    "accounts" : "accounts",
    "node_count" : 5,
    "node_list" : "node_list",
    "purge_completed" : {
      "time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "core_count" : 0
  }, {
    "end_time" : 6,
    "flags" : [ "MAINT", "MAINT" ],
    "groups" : "groups",
    "users" : "users",
    "max_start_delay" : 1,
    "features" : "features",
    "start_time" : 5,
    "burst_buffer" : "burst_buffer",
    "licenses" : "licenses",
    "partition" : "partition",
    "watts" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "core_specializations" : [ {
      "node" : "node",
      "core" : "core"
    }, {
      "node" : "node",
      "core" : "core"
    } ],
    "name" : "name",
    "tres" : "tres",
    "accounts" : "accounts",
    "node_count" : 5,
    "node_list" : "node_list",
    "purge_completed" : {
      "time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "core_count" : 0
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

reservation information v0.0.39_reservations_response

default

no reservations found status

Up
get /slurm/v0.0.39/ping
ping test (slurmV0039Ping)

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "pings" : [ {
    "mode" : "mode",
    "hostname" : "hostname",
    "latency" : 0,
    "pinged" : "pinged"
  }, {
    "mode" : "mode",
    "hostname" : "hostname",
    "latency" : 0,
    "pinged" : "pinged"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

results of ping test v0.0.39_pings

default

unable to request ping test status

Up
get /slurm/v0.0.39/licenses
get all Slurm tracked license info (slurmV0039SlurmctldGetLicenses)

Return type

Example data

Content-Type: application/json
{
  "licenses" : [ {
    "Used" : 6,
    "LastUpdate" : 7,
    "Total" : 0,
    "Remote" : true,
    "LastConsumed" : 5,
    "LastDeficit" : 2,
    "LicenseName" : "LicenseName",
    "Free" : 1,
    "Reserved" : 5
  }, {
    "Used" : 6,
    "LastUpdate" : 7,
    "Total" : 0,
    "Remote" : true,
    "LastConsumed" : 5,
    "LastDeficit" : 2,
    "LicenseName" : "LicenseName",
    "Free" : 1,
    "Reserved" : 5
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

results of get all licenses v0.0.39_licenses_info

default

unable to request licenses

Up
post /slurm/v0.0.39/job/submit
submit new job (slurmV0039SubmitJob)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

v0.0.39_job_submission v0.0.39_job_submission (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "job_id" : 0,
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "step_id" : "step_id",
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ],
  "job_submit_user_msg" : "job_submit_user_msg"
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

job submitted v0.0.39_job_submission_response

default

job rejected status

Up
post /slurm/v0.0.39/job/{job_id}
update job (slurmV0039UpdateJob)

Path parameters

job_id (required)
Path Parameter — Slurm Job ID default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

v0.0.39_job_desc_msg v0.0.39_job_desc_msg (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "results" : [ {
    "job_id" : 0,
    "why" : "why",
    "error_code" : 6,
    "error" : "error"
  }, {
    "job_id" : 0,
    "why" : "why",
    "error_code" : 6,
    "error" : "error"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 0
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

job updated v0.0.39_job_update_response

default

job update failed status

Up
post /slurm/v0.0.39/node/{node_name}
update node properties (slurmV0039UpdateNode)

Path parameters

node_name (required)
Path Parameter — Slurm Node Name default: null

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

v0.0.39_update_node_msg v0.0.39_update_node_msg (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

node information status

default

node update failed status

Up
post /slurmdb/v0.0.39/clusters
Add clusters (slurmdbV0039AddClusters)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

dbv0.0.39_clusters_info dbv0.0.39_clusters_info (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of clusters status

default

Unable to add cluster status

Up
post /slurmdb/v0.0.39/wckeys
Add wckeys (slurmdbV0039AddWckeys)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

dbv0.0.39_wckey_info dbv0.0.39_wckey_info (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of wckeys status

default

Unable to add wckey status

Up
delete /slurmdb/v0.0.39/account/{account_name}
Delete account (slurmdbV0039DeleteAccount)

Path parameters

account_name (required)
Path Parameter — Slurm Account Name default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Delete account status

default

Unable to delete account status

Up
delete /slurmdb/v0.0.39/association
Delete association (slurmdbV0039DeleteAssociation)

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
{
  "removed_associations" : [ "removed_associations", "removed_associations" ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Delete associations dbv0.0.39_response_associations_delete

default

Association not found or unable to delete association status

Up
delete /slurmdb/v0.0.39/associations
Delete associations (slurmdbV0039DeleteAssociations)

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
{
  "removed_associations" : [ "removed_associations", "removed_associations" ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Delete associations dbv0.0.39_response_associations_delete

default

Associations not found or unable to delete association status

Up
delete /slurmdb/v0.0.39/cluster/{cluster_name}
Delete cluster (slurmdbV0039DeleteCluster)

Path parameters

cluster_name (required)
Path Parameter — Slurm cluster name default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Delete cluster status

default

Cluster not found or unable to delete cluster status

Up
delete /slurmdb/v0.0.39/qos/{qos_name}
Delete QOS (slurmdbV0039DeleteQos)

Path parameters

qos_name (required)
Path Parameter — Slurm QOS Name default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Delete qos status

default

Unable to delete QOS status

Up
delete /slurmdb/v0.0.39/user/{user_name}
Delete user (slurmdbV0039DeleteUser)

Path parameters

user_name (required)
Path Parameter — Slurm User Name default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

User deleted status

default

User not found or unable to delete user status

Up
delete /slurmdb/v0.0.39/wckey/{wckey}
Delete wckey (slurmdbV0039DeleteWckey)

Path parameters

wckey (required)
Path Parameter — Slurm wckey name default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Delete wckey status

default

wckey not found or unable to delete wckey status

Up
get /slurmdb/v0.0.39/diag
Get slurmdb diagnostics (slurmdbV0039Diag)

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ],
  "statistics" : {
    "time_start" : 0,
    "RPCs" : [ {
      "rpc" : "rpc",
      "count" : 7,
      "time" : {
        "total" : 9
      }
    }, {
      "rpc" : "rpc",
      "count" : 7,
      "time" : {
        "total" : 9
      }
    } ],
    "rollups" : [ {
      "max_cycle" : 1,
      "mean_cycles" : 2,
      "last run" : 6,
      "type" : "internal",
      "total_time" : 5,
      "total_cycles" : 5
    }, {
      "max_cycle" : 1,
      "mean_cycles" : 2,
      "last run" : 6,
      "type" : "internal",
      "total_time" : 5,
      "total_cycles" : 5
    } ],
    "users" : [ {
      "count" : 3,
      "time" : {
        "total" : 9
      },
      "user" : "user"
    }, {
      "count" : 3,
      "time" : {
        "total" : 9
      },
      "user" : "user"
    } ]
  }
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Dictionary of statistics dbv0.0.39_diag

default

Unable to query diagnostics status

Up
get /slurmdb/v0.0.39/account/{account_name}
Get account info (slurmdbV0039GetAccount)

Path parameters

account_name (required)
Path Parameter — Slurm Account Name default: null

Query parameters

with_deleted (optional)
Query Parameter — Include deleted accounts. False by default. default: false

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "accounts" : [ {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "organization" : "organization",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "description" : "description"
  }, {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "organization" : "organization",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "description" : "description"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of accounts dbv0.0.39_account_info

default

Account not found status

Up
get /slurmdb/v0.0.39/accounts
Get account list (slurmdbV0039GetAccounts)

Query parameters

with_deleted (optional)
Query Parameter — Include deleted accounts. False by default. default: false

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "accounts" : [ {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "organization" : "organization",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "description" : "description"
  }, {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "organization" : "organization",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "description" : "description"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of accounts dbv0.0.39_account_info

default

Account not found status

Up
get /slurmdb/v0.0.39/association
Get association info (slurmdbV0039GetAssociation)

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" : 0,
    "max" : {
      "jobs" : {
        "per" : {
          "wall_clock" : {
            "number" : 3,
            "set" : false,
            "infinite" : true
          }
        }
      }
    },
    "usage" : {
      "fairshare_factor" : 5.962133916683182,
      "normalized_shares" : 7.061401241503109,
      "effective_normalized_usage" : 9.301444243932576,
      "job_count" : 7,
      "group_used_wallclock" : 1.4658129805029452,
      "normalized_priority" : 2.3021358869347655,
      "normalized_usage" : 3.616076749251911,
      "accrue_job_count" : 6,
      "fairshare_shares" : 5,
      "fairshare_level" : 1.2315135367772556,
      "raw_usage" : 2.027123023002322,
      "active_jobs" : 4
    },
    "flags" : [ "DELETED", "DELETED" ],
    "is_default" : true,
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "parent_account" : "parent_account",
    "default" : {
      "qos" : "qos"
    },
    "min" : {
      "priority_threshold" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "partition" : "partition",
    "qos" : [ "qos", "qos" ],
    "user" : "user",
    "account" : "account"
  }, {
    "cluster" : "cluster",
    "shares_raw" : 0,
    "max" : {
      "jobs" : {
        "per" : {
          "wall_clock" : {
            "number" : 3,
            "set" : false,
            "infinite" : true
          }
        }
      }
    },
    "usage" : {
      "fairshare_factor" : 5.962133916683182,
      "normalized_shares" : 7.061401241503109,
      "effective_normalized_usage" : 9.301444243932576,
      "job_count" : 7,
      "group_used_wallclock" : 1.4658129805029452,
      "normalized_priority" : 2.3021358869347655,
      "normalized_usage" : 3.616076749251911,
      "accrue_job_count" : 6,
      "fairshare_shares" : 5,
      "fairshare_level" : 1.2315135367772556,
      "raw_usage" : 2.027123023002322,
      "active_jobs" : 4
    },
    "flags" : [ "DELETED", "DELETED" ],
    "is_default" : true,
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "parent_account" : "parent_account",
    "default" : {
      "qos" : "qos"
    },
    "min" : {
      "priority_threshold" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "partition" : "partition",
    "qos" : [ "qos", "qos" ],
    "user" : "user",
    "account" : "account"
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of associations dbv0.0.39_associations_info

default

Association not found status

Up
get /slurmdb/v0.0.39/associations
Get association list (slurmdbV0039GetAssociations)

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" : 0,
    "max" : {
      "jobs" : {
        "per" : {
          "wall_clock" : {
            "number" : 3,
            "set" : false,
            "infinite" : true
          }
        }
      }
    },
    "usage" : {
      "fairshare_factor" : 5.962133916683182,
      "normalized_shares" : 7.061401241503109,
      "effective_normalized_usage" : 9.301444243932576,
      "job_count" : 7,
      "group_used_wallclock" : 1.4658129805029452,
      "normalized_priority" : 2.3021358869347655,
      "normalized_usage" : 3.616076749251911,
      "accrue_job_count" : 6,
      "fairshare_shares" : 5,
      "fairshare_level" : 1.2315135367772556,
      "raw_usage" : 2.027123023002322,
      "active_jobs" : 4
    },
    "flags" : [ "DELETED", "DELETED" ],
    "is_default" : true,
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "parent_account" : "parent_account",
    "default" : {
      "qos" : "qos"
    },
    "min" : {
      "priority_threshold" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "partition" : "partition",
    "qos" : [ "qos", "qos" ],
    "user" : "user",
    "account" : "account"
  }, {
    "cluster" : "cluster",
    "shares_raw" : 0,
    "max" : {
      "jobs" : {
        "per" : {
          "wall_clock" : {
            "number" : 3,
            "set" : false,
            "infinite" : true
          }
        }
      }
    },
    "usage" : {
      "fairshare_factor" : 5.962133916683182,
      "normalized_shares" : 7.061401241503109,
      "effective_normalized_usage" : 9.301444243932576,
      "job_count" : 7,
      "group_used_wallclock" : 1.4658129805029452,
      "normalized_priority" : 2.3021358869347655,
      "normalized_usage" : 3.616076749251911,
      "accrue_job_count" : 6,
      "fairshare_shares" : 5,
      "fairshare_level" : 1.2315135367772556,
      "raw_usage" : 2.027123023002322,
      "active_jobs" : 4
    },
    "flags" : [ "DELETED", "DELETED" ],
    "is_default" : true,
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "parent_account" : "parent_account",
    "default" : {
      "qos" : "qos"
    },
    "min" : {
      "priority_threshold" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "partition" : "partition",
    "qos" : [ "qos", "qos" ],
    "user" : "user",
    "account" : "account"
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of associations dbv0.0.39_associations_info

default

Association not found status

Up
get /slurmdb/v0.0.39/cluster/{cluster_name}
Get cluster info (slurmdbV0039GetCluster)

Path parameters

cluster_name (required)
Path Parameter — Slurm cluster name default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ],
  "clusters" : [ {
    "associations" : {
      "root" : {
        "cluster" : "cluster",
        "partition" : "partition",
        "user" : "user",
        "account" : "account"
      }
    },
    "controller" : {
      "port" : 9
    },
    "nodes" : "nodes",
    "flags" : [ "REGISTERING", "REGISTERING" ],
    "name" : "name",
    "rpc_version" : 9,
    "tres" : [ {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    }, {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    } ],
    "select_plugin" : "select_plugin"
  }, {
    "associations" : {
      "root" : {
        "cluster" : "cluster",
        "partition" : "partition",
        "user" : "user",
        "account" : "account"
      }
    },
    "controller" : {
      "port" : 9
    },
    "nodes" : "nodes",
    "flags" : [ "REGISTERING", "REGISTERING" ],
    "name" : "name",
    "rpc_version" : 9,
    "tres" : [ {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    }, {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    } ],
    "select_plugin" : "select_plugin"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Cluster information dbv0.0.39_clusters_info

default

Cluster not found status

Up
get /slurmdb/v0.0.39/clusters
Get cluster list (slurmdbV0039GetClusters)

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ],
  "clusters" : [ {
    "associations" : {
      "root" : {
        "cluster" : "cluster",
        "partition" : "partition",
        "user" : "user",
        "account" : "account"
      }
    },
    "controller" : {
      "port" : 9
    },
    "nodes" : "nodes",
    "flags" : [ "REGISTERING", "REGISTERING" ],
    "name" : "name",
    "rpc_version" : 9,
    "tres" : [ {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    }, {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    } ],
    "select_plugin" : "select_plugin"
  }, {
    "associations" : {
      "root" : {
        "cluster" : "cluster",
        "partition" : "partition",
        "user" : "user",
        "account" : "account"
      }
    },
    "controller" : {
      "port" : 9
    },
    "nodes" : "nodes",
    "flags" : [ "REGISTERING", "REGISTERING" ],
    "name" : "name",
    "rpc_version" : 9,
    "tres" : [ {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    }, {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    } ],
    "select_plugin" : "select_plugin"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of clusters dbv0.0.39_clusters_info

default

Cluster not found status

Up
get /slurmdb/v0.0.39/config
Dump all configuration information (slurmdbV0039GetConfig)

Return type

Example data

Content-Type: application/json
{
  "associations" : [ {
    "cluster" : "cluster",
    "shares_raw" : 0,
    "max" : {
      "jobs" : {
        "per" : {
          "wall_clock" : {
            "number" : 3,
            "set" : false,
            "infinite" : true
          }
        }
      }
    },
    "usage" : {
      "fairshare_factor" : 5.962133916683182,
      "normalized_shares" : 7.061401241503109,
      "effective_normalized_usage" : 9.301444243932576,
      "job_count" : 7,
      "group_used_wallclock" : 1.4658129805029452,
      "normalized_priority" : 2.3021358869347655,
      "normalized_usage" : 3.616076749251911,
      "accrue_job_count" : 6,
      "fairshare_shares" : 5,
      "fairshare_level" : 1.2315135367772556,
      "raw_usage" : 2.027123023002322,
      "active_jobs" : 4
    },
    "flags" : [ "DELETED", "DELETED" ],
    "is_default" : true,
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "parent_account" : "parent_account",
    "default" : {
      "qos" : "qos"
    },
    "min" : {
      "priority_threshold" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "partition" : "partition",
    "qos" : [ "qos", "qos" ],
    "user" : "user",
    "account" : "account"
  }, {
    "cluster" : "cluster",
    "shares_raw" : 0,
    "max" : {
      "jobs" : {
        "per" : {
          "wall_clock" : {
            "number" : 3,
            "set" : false,
            "infinite" : true
          }
        }
      }
    },
    "usage" : {
      "fairshare_factor" : 5.962133916683182,
      "normalized_shares" : 7.061401241503109,
      "effective_normalized_usage" : 9.301444243932576,
      "job_count" : 7,
      "group_used_wallclock" : 1.4658129805029452,
      "normalized_priority" : 2.3021358869347655,
      "normalized_usage" : 3.616076749251911,
      "accrue_job_count" : 6,
      "fairshare_shares" : 5,
      "fairshare_level" : 1.2315135367772556,
      "raw_usage" : 2.027123023002322,
      "active_jobs" : 4
    },
    "flags" : [ "DELETED", "DELETED" ],
    "is_default" : true,
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "parent_account" : "parent_account",
    "default" : {
      "qos" : "qos"
    },
    "min" : {
      "priority_threshold" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "partition" : "partition",
    "qos" : [ "qos", "qos" ],
    "user" : "user",
    "account" : "account"
  } ],
  "qos" : [ {
    "flags" : [ "NOT_SET", "NOT_SET" ],
    "name" : "name",
    "usage_threshold" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "description" : "description",
    "usage_factor" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "id" : 1,
    "priority" : 4,
    "limits" : {
      "min" : {
        "tres" : {
          "per" : {
            "job" : [ {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            }, {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            } ]
          }
        }
      }
    },
    "preempt" : {
      "exempt_time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    }
  }, {
    "flags" : [ "NOT_SET", "NOT_SET" ],
    "name" : "name",
    "usage_threshold" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "description" : "description",
    "usage_factor" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "id" : 1,
    "priority" : 4,
    "limits" : {
      "min" : {
        "tres" : {
          "per" : {
            "job" : [ {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            }, {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            } ]
          }
        }
      }
    },
    "preempt" : {
      "exempt_time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    }
  } ],
  "wckeys" : [ {
    "cluster" : "cluster",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "accounting" : [ {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    }, {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    } ],
    "id" : 7,
    "user" : "user"
  }, {
    "cluster" : "cluster",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "accounting" : [ {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    }, {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    } ],
    "id" : 7,
    "user" : "user"
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "tres" : [ {
    "name" : "name",
    "count" : 6,
    "id" : 1,
    "type" : "type"
  }, {
    "name" : "name",
    "count" : 6,
    "id" : 1,
    "type" : "type"
  } ],
  "accounts" : [ {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "organization" : "organization",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "description" : "description"
  }, {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "organization" : "organization",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "description" : "description"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ],
  "users" : [ {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "default" : {
      "wckey" : "wckey"
    },
    "administrator_level" : [ "Not Set", "Not Set" ],
    "old_name" : "old_name",
    "wckeys" : [ {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    }, {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "flags" : [ "NONE", "NONE" ],
    "name" : "name"
  }, {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "default" : {
      "wckey" : "wckey"
    },
    "administrator_level" : [ "Not Set", "Not Set" ],
    "old_name" : "old_name",
    "wckeys" : [ {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    }, {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "flags" : [ "NONE", "NONE" ],
    "name" : "name"
  } ],
  "clusters" : [ {
    "associations" : {
      "root" : {
        "cluster" : "cluster",
        "partition" : "partition",
        "user" : "user",
        "account" : "account"
      }
    },
    "controller" : {
      "port" : 9
    },
    "nodes" : "nodes",
    "flags" : [ "REGISTERING", "REGISTERING" ],
    "name" : "name",
    "rpc_version" : 9,
    "tres" : [ {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    }, {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    } ],
    "select_plugin" : "select_plugin"
  }, {
    "associations" : {
      "root" : {
        "cluster" : "cluster",
        "partition" : "partition",
        "user" : "user",
        "account" : "account"
      }
    },
    "controller" : {
      "port" : 9
    },
    "nodes" : "nodes",
    "flags" : [ "REGISTERING", "REGISTERING" ],
    "name" : "name",
    "rpc_version" : 9,
    "tres" : [ {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    }, {
      "name" : "name",
      "count" : 6,
      "id" : 1,
      "type" : "type"
    } ],
    "select_plugin" : "select_plugin"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

slurmdbd configuration dbv0.0.39_config_info

default

Unable to dump config status

Up
get /slurmdb/v0.0.39/job/{job_id}
Get job info (slurmdbV0039GetJob)
This endpoint may return multiple job entries since job_id is not a unique key - only the tuple (cluster, job_id, start_time) is unique. If the requested job_id is a component of a heterogeneous job all components are returned.

Path parameters

job_id (required)
Path Parameter — Slurm JobID default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "jobs" : [ {
    "container" : "container",
    "cluster" : "cluster",
    "flags" : [ "NONE", "NONE" ],
    "used_gres" : "used_gres",
    "association" : {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    },
    "allocation_nodes" : 5,
    "working_directory" : "working_directory",
    "constraints" : "constraints",
    "required" : {
      "memory" : 4
    },
    "partition" : "partition",
    "qos" : "qos",
    "array" : {
      "task" : "task"
    },
    "het" : {
      "job_offset" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "submit_line" : "submit_line",
    "extra" : "extra",
    "reservation" : {
      "name" : "name"
    },
    "block" : "block",
    "tres" : {
      "requested" : [ {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      }, {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      } ]
    },
    "state" : {
      "reason" : "reason"
    },
    "mcs" : {
      "label" : "label"
    },
    "group" : "group",
    "wckey" : {
      "wckey" : "wckey",
      "flags" : [ "ASSIGNED_DEFAULT", "ASSIGNED_DEFAULT" ]
    },
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "steps" : [ {
      "nodes" : {
        "list" : [ "list", "list" ]
      },
      "task" : {
        "distribution" : "distribution"
      },
      "exit_code" : {
        "return_code" : 2,
        "signal" : {
          "name" : "name",
          "signal_id" : 7
        },
        "status" : "status"
      },
      "kill_request_user" : "kill_request_user",
      "CPU" : {
        "governor" : "governor"
      },
      "pid" : "pid",
      "step" : {
        "name" : "name"
      },
      "tres" : {
        "allocated" : [ {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        }, {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        } ]
      },
      "time" : {
        "user" : {
          "microseconds" : 7
        }
      },
      "state" : "state",
      "tasks" : {
        "count" : 1
      },
      "statistics" : {
        "energy" : {
          "consumed" : {
            "number" : 1,
            "set" : false,
            "infinite" : true
          }
        }
      }
    }, {
      "nodes" : {
        "list" : [ "list", "list" ]
      },
      "task" : {
        "distribution" : "distribution"
      },
      "exit_code" : {
        "return_code" : 2,
        "signal" : {
          "name" : "name",
          "signal_id" : 7
        },
        "status" : "status"
      },
      "kill_request_user" : "kill_request_user",
      "CPU" : {
        "governor" : "governor"
      },
      "pid" : "pid",
      "step" : {
        "name" : "name"
      },
      "tres" : {
        "allocated" : [ {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        }, {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        } ]
      },
      "time" : {
        "user" : {
          "microseconds" : 7
        }
      },
      "state" : "state",
      "tasks" : {
        "count" : 1
      },
      "statistics" : {
        "energy" : {
          "consumed" : {
            "number" : 1,
            "set" : false,
            "infinite" : true
          }
        }
      }
    } ],
    "script" : "script",
    "failed_node" : "failed_node",
    "derived_exit_code" : {
      "return_code" : 2,
      "signal" : {
        "name" : "name",
        "signal_id" : 7
      },
      "status" : "status"
    },
    "licenses" : "licenses",
    "nodes" : "nodes",
    "job_id" : 2,
    "exit_code" : {
      "return_code" : 2,
      "signal" : {
        "name" : "name",
        "signal_id" : 7
      },
      "status" : "status"
    },
    "name" : "name",
    "kill_request_user" : "kill_request_user",
    "comment" : {
      "system" : "system"
    },
    "time" : {
      "user" : {
        "microseconds" : 9
      }
    },
    "user" : "user",
    "account" : "account"
  }, {
    "container" : "container",
    "cluster" : "cluster",
    "flags" : [ "NONE", "NONE" ],
    "used_gres" : "used_gres",
    "association" : {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    },
    "allocation_nodes" : 5,
    "working_directory" : "working_directory",
    "constraints" : "constraints",
    "required" : {
      "memory" : 4
    },
    "partition" : "partition",
    "qos" : "qos",
    "array" : {
      "task" : "task"
    },
    "het" : {
      "job_offset" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "submit_line" : "submit_line",
    "extra" : "extra",
    "reservation" : {
      "name" : "name"
    },
    "block" : "block",
    "tres" : {
      "requested" : [ {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      }, {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      } ]
    },
    "state" : {
      "reason" : "reason"
    },
    "mcs" : {
      "label" : "label"
    },
    "group" : "group",
    "wckey" : {
      "wckey" : "wckey",
      "flags" : [ "ASSIGNED_DEFAULT", "ASSIGNED_DEFAULT" ]
    },
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "steps" : [ {
      "nodes" : {
        "list" : [ "list", "list" ]
      },
      "task" : {
        "distribution" : "distribution"
      },
      "exit_code" : {
        "return_code" : 2,
        "signal" : {
          "name" : "name",
          "signal_id" : 7
        },
        "status" : "status"
      },
      "kill_request_user" : "kill_request_user",
      "CPU" : {
        "governor" : "governor"
      },
      "pid" : "pid",
      "step" : {
        "name" : "name"
      },
      "tres" : {
        "allocated" : [ {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        }, {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        } ]
      },
      "time" : {
        "user" : {
          "microseconds" : 7
        }
      },
      "state" : "state",
      "tasks" : {
        "count" : 1
      },
      "statistics" : {
        "energy" : {
          "consumed" : {
            "number" : 1,
            "set" : false,
            "infinite" : true
          }
        }
      }
    }, {
      "nodes" : {
        "list" : [ "list", "list" ]
      },
      "task" : {
        "distribution" : "distribution"
      },
      "exit_code" : {
        "return_code" : 2,
        "signal" : {
          "name" : "name",
          "signal_id" : 7
        },
        "status" : "status"
      },
      "kill_request_user" : "kill_request_user",
      "CPU" : {
        "governor" : "governor"
      },
      "pid" : "pid",
      "step" : {
        "name" : "name"
      },
      "tres" : {
        "allocated" : [ {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        }, {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        } ]
      },
      "time" : {
        "user" : {
          "microseconds" : 7
        }
      },
      "state" : "state",
      "tasks" : {
        "count" : 1
      },
      "statistics" : {
        "energy" : {
          "consumed" : {
            "number" : 1,
            "set" : false,
            "infinite" : true
          }
        }
      }
    } ],
    "script" : "script",
    "failed_node" : "failed_node",
    "derived_exit_code" : {
      "return_code" : 2,
      "signal" : {
        "name" : "name",
        "signal_id" : 7
      },
      "status" : "status"
    },
    "licenses" : "licenses",
    "nodes" : "nodes",
    "job_id" : 2,
    "exit_code" : {
      "return_code" : 2,
      "signal" : {
        "name" : "name",
        "signal_id" : 7
      },
      "status" : "status"
    },
    "name" : "name",
    "kill_request_user" : "kill_request_user",
    "comment" : {
      "system" : "system"
    },
    "time" : {
      "user" : {
        "microseconds" : 9
      }
    },
    "user" : "user",
    "account" : "account"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Job description dbv0.0.39_job_info

default

Unable to find job status

Up
get /slurmdb/v0.0.39/jobs
Get job list (slurmdbV0039GetJobs)

Query parameters

users (optional)
Query Parameter — Filter by comma delimited list of user names default: null
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: false
disable_wait_for_result (optional)
Query Parameter — Disable waiting for result from slurmdbd default: false
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
wckey (optional)
Query Parameter — Comma delimited list of wckeys to match default: null

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "jobs" : [ {
    "container" : "container",
    "cluster" : "cluster",
    "flags" : [ "NONE", "NONE" ],
    "used_gres" : "used_gres",
    "association" : {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    },
    "allocation_nodes" : 5,
    "working_directory" : "working_directory",
    "constraints" : "constraints",
    "required" : {
      "memory" : 4
    },
    "partition" : "partition",
    "qos" : "qos",
    "array" : {
      "task" : "task"
    },
    "het" : {
      "job_offset" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "submit_line" : "submit_line",
    "extra" : "extra",
    "reservation" : {
      "name" : "name"
    },
    "block" : "block",
    "tres" : {
      "requested" : [ {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      }, {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      } ]
    },
    "state" : {
      "reason" : "reason"
    },
    "mcs" : {
      "label" : "label"
    },
    "group" : "group",
    "wckey" : {
      "wckey" : "wckey",
      "flags" : [ "ASSIGNED_DEFAULT", "ASSIGNED_DEFAULT" ]
    },
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "steps" : [ {
      "nodes" : {
        "list" : [ "list", "list" ]
      },
      "task" : {
        "distribution" : "distribution"
      },
      "exit_code" : {
        "return_code" : 2,
        "signal" : {
          "name" : "name",
          "signal_id" : 7
        },
        "status" : "status"
      },
      "kill_request_user" : "kill_request_user",
      "CPU" : {
        "governor" : "governor"
      },
      "pid" : "pid",
      "step" : {
        "name" : "name"
      },
      "tres" : {
        "allocated" : [ {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        }, {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        } ]
      },
      "time" : {
        "user" : {
          "microseconds" : 7
        }
      },
      "state" : "state",
      "tasks" : {
        "count" : 1
      },
      "statistics" : {
        "energy" : {
          "consumed" : {
            "number" : 1,
            "set" : false,
            "infinite" : true
          }
        }
      }
    }, {
      "nodes" : {
        "list" : [ "list", "list" ]
      },
      "task" : {
        "distribution" : "distribution"
      },
      "exit_code" : {
        "return_code" : 2,
        "signal" : {
          "name" : "name",
          "signal_id" : 7
        },
        "status" : "status"
      },
      "kill_request_user" : "kill_request_user",
      "CPU" : {
        "governor" : "governor"
      },
      "pid" : "pid",
      "step" : {
        "name" : "name"
      },
      "tres" : {
        "allocated" : [ {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        }, {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        } ]
      },
      "time" : {
        "user" : {
          "microseconds" : 7
        }
      },
      "state" : "state",
      "tasks" : {
        "count" : 1
      },
      "statistics" : {
        "energy" : {
          "consumed" : {
            "number" : 1,
            "set" : false,
            "infinite" : true
          }
        }
      }
    } ],
    "script" : "script",
    "failed_node" : "failed_node",
    "derived_exit_code" : {
      "return_code" : 2,
      "signal" : {
        "name" : "name",
        "signal_id" : 7
      },
      "status" : "status"
    },
    "licenses" : "licenses",
    "nodes" : "nodes",
    "job_id" : 2,
    "exit_code" : {
      "return_code" : 2,
      "signal" : {
        "name" : "name",
        "signal_id" : 7
      },
      "status" : "status"
    },
    "name" : "name",
    "kill_request_user" : "kill_request_user",
    "comment" : {
      "system" : "system"
    },
    "time" : {
      "user" : {
        "microseconds" : 9
      }
    },
    "user" : "user",
    "account" : "account"
  }, {
    "container" : "container",
    "cluster" : "cluster",
    "flags" : [ "NONE", "NONE" ],
    "used_gres" : "used_gres",
    "association" : {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    },
    "allocation_nodes" : 5,
    "working_directory" : "working_directory",
    "constraints" : "constraints",
    "required" : {
      "memory" : 4
    },
    "partition" : "partition",
    "qos" : "qos",
    "array" : {
      "task" : "task"
    },
    "het" : {
      "job_offset" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    },
    "submit_line" : "submit_line",
    "extra" : "extra",
    "reservation" : {
      "name" : "name"
    },
    "block" : "block",
    "tres" : {
      "requested" : [ {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      }, {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      } ]
    },
    "state" : {
      "reason" : "reason"
    },
    "mcs" : {
      "label" : "label"
    },
    "group" : "group",
    "wckey" : {
      "wckey" : "wckey",
      "flags" : [ "ASSIGNED_DEFAULT", "ASSIGNED_DEFAULT" ]
    },
    "priority" : {
      "number" : 3,
      "set" : false,
      "infinite" : true
    },
    "steps" : [ {
      "nodes" : {
        "list" : [ "list", "list" ]
      },
      "task" : {
        "distribution" : "distribution"
      },
      "exit_code" : {
        "return_code" : 2,
        "signal" : {
          "name" : "name",
          "signal_id" : 7
        },
        "status" : "status"
      },
      "kill_request_user" : "kill_request_user",
      "CPU" : {
        "governor" : "governor"
      },
      "pid" : "pid",
      "step" : {
        "name" : "name"
      },
      "tres" : {
        "allocated" : [ {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        }, {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        } ]
      },
      "time" : {
        "user" : {
          "microseconds" : 7
        }
      },
      "state" : "state",
      "tasks" : {
        "count" : 1
      },
      "statistics" : {
        "energy" : {
          "consumed" : {
            "number" : 1,
            "set" : false,
            "infinite" : true
          }
        }
      }
    }, {
      "nodes" : {
        "list" : [ "list", "list" ]
      },
      "task" : {
        "distribution" : "distribution"
      },
      "exit_code" : {
        "return_code" : 2,
        "signal" : {
          "name" : "name",
          "signal_id" : 7
        },
        "status" : "status"
      },
      "kill_request_user" : "kill_request_user",
      "CPU" : {
        "governor" : "governor"
      },
      "pid" : "pid",
      "step" : {
        "name" : "name"
      },
      "tres" : {
        "allocated" : [ {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        }, {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        } ]
      },
      "time" : {
        "user" : {
          "microseconds" : 7
        }
      },
      "state" : "state",
      "tasks" : {
        "count" : 1
      },
      "statistics" : {
        "energy" : {
          "consumed" : {
            "number" : 1,
            "set" : false,
            "infinite" : true
          }
        }
      }
    } ],
    "script" : "script",
    "failed_node" : "failed_node",
    "derived_exit_code" : {
      "return_code" : 2,
      "signal" : {
        "name" : "name",
        "signal_id" : 7
      },
      "status" : "status"
    },
    "licenses" : "licenses",
    "nodes" : "nodes",
    "job_id" : 2,
    "exit_code" : {
      "return_code" : 2,
      "signal" : {
        "name" : "name",
        "signal_id" : 7
      },
      "status" : "status"
    },
    "name" : "name",
    "kill_request_user" : "kill_request_user",
    "comment" : {
      "system" : "system"
    },
    "time" : {
      "user" : {
        "microseconds" : 9
      }
    },
    "user" : "user",
    "account" : "account"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of jobs dbv0.0.39_job_info

default

Unable to query jobs status

Up
get /slurmdb/v0.0.39/qos
Get QOS list (slurmdbV0039GetQos)

Query parameters

with_deleted (optional)
Query Parameter — Include deleted QOSs. False by default. default: false

Return type

Example data

Content-Type: application/json
{
  "qos" : [ {
    "flags" : [ "NOT_SET", "NOT_SET" ],
    "name" : "name",
    "usage_threshold" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "description" : "description",
    "usage_factor" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "id" : 1,
    "priority" : 4,
    "limits" : {
      "min" : {
        "tres" : {
          "per" : {
            "job" : [ {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            }, {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            } ]
          }
        }
      }
    },
    "preempt" : {
      "exempt_time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    }
  }, {
    "flags" : [ "NOT_SET", "NOT_SET" ],
    "name" : "name",
    "usage_threshold" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "description" : "description",
    "usage_factor" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "id" : 1,
    "priority" : 4,
    "limits" : {
      "min" : {
        "tres" : {
          "per" : {
            "job" : [ {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            }, {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            } ]
          }
        }
      }
    },
    "preempt" : {
      "exempt_time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    }
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of QOS' dbv0.0.39_qos_info

default

QOS not found status

Up
get /slurmdb/v0.0.39/qos/{qos_name}
Get QOS info (slurmdbV0039GetSingleQos)

Path parameters

qos_name (required)
Path Parameter — Slurm QOS Name default: null

Query parameters

with_deleted (optional)
Query Parameter — Include deleted QOSs. False by default. default: false

Return type

Example data

Content-Type: application/json
{
  "qos" : [ {
    "flags" : [ "NOT_SET", "NOT_SET" ],
    "name" : "name",
    "usage_threshold" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "description" : "description",
    "usage_factor" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "id" : 1,
    "priority" : 4,
    "limits" : {
      "min" : {
        "tres" : {
          "per" : {
            "job" : [ {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            }, {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            } ]
          }
        }
      }
    },
    "preempt" : {
      "exempt_time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    }
  }, {
    "flags" : [ "NOT_SET", "NOT_SET" ],
    "name" : "name",
    "usage_threshold" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "description" : "description",
    "usage_factor" : {
      "number" : 5.025004791520295,
      "set" : false,
      "infinite" : true
    },
    "id" : 1,
    "priority" : 4,
    "limits" : {
      "min" : {
        "tres" : {
          "per" : {
            "job" : [ {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            }, {
              "name" : "name",
              "count" : 6,
              "id" : 1,
              "type" : "type"
            } ]
          }
        }
      }
    },
    "preempt" : {
      "exempt_time" : {
        "number" : 3,
        "set" : false,
        "infinite" : true
      }
    }
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

QOS information dbv0.0.39_qos_info

default

QOS not found status

Up
get /slurmdb/v0.0.39/tres
Get TRES info (slurmdbV0039GetTres)

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "tres" : [ {
    "name" : "name",
    "count" : 6,
    "id" : 1,
    "type" : "type"
  }, {
    "name" : "name",
    "count" : 6,
    "id" : 1,
    "type" : "type"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of TRES dbv0.0.39_tres_info

default

Unable to retrieve TRES

Up
get /slurmdb/v0.0.39/user/{user_name}
Get user info (slurmdbV0039GetUser)

Path parameters

user_name (required)
Path Parameter — Slurm User Name default: null

Query parameters

with_deleted (optional)
Query Parameter — Include deleted users. False by default. default: false

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ],
  "users" : [ {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "default" : {
      "wckey" : "wckey"
    },
    "administrator_level" : [ "Not Set", "Not Set" ],
    "old_name" : "old_name",
    "wckeys" : [ {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    }, {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "flags" : [ "NONE", "NONE" ],
    "name" : "name"
  }, {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "default" : {
      "wckey" : "wckey"
    },
    "administrator_level" : [ "Not Set", "Not Set" ],
    "old_name" : "old_name",
    "wckeys" : [ {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    }, {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "flags" : [ "NONE", "NONE" ],
    "name" : "name"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of users dbv0.0.39_user_info

default

User not found status

Up
get /slurmdb/v0.0.39/users
Get user list (slurmdbV0039GetUsers)

Query parameters

with_deleted (optional)
Query Parameter — Include deleted users. False by default. default: false

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ],
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ],
  "users" : [ {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "default" : {
      "wckey" : "wckey"
    },
    "administrator_level" : [ "Not Set", "Not Set" ],
    "old_name" : "old_name",
    "wckeys" : [ {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    }, {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "flags" : [ "NONE", "NONE" ],
    "name" : "name"
  }, {
    "associations" : [ {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    }, {
      "cluster" : "cluster",
      "partition" : "partition",
      "user" : "user",
      "account" : "account"
    } ],
    "default" : {
      "wckey" : "wckey"
    },
    "administrator_level" : [ "Not Set", "Not Set" ],
    "old_name" : "old_name",
    "wckeys" : [ {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    }, {
      "cluster" : "cluster",
      "name" : "name",
      "flags" : [ "DELETED", "DELETED" ],
      "accounting" : [ {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      }, {
        "start" : 6,
        "id" : 1,
        "TRES" : {
          "name" : "name",
          "count" : 6,
          "id" : 1,
          "type" : "type"
        },
        "allocated" : {
          "seconds" : 1
        }
      } ],
      "id" : 7,
      "user" : "user"
    } ],
    "coordinators" : [ {
      "name" : "name",
      "direct" : true
    }, {
      "name" : "name",
      "direct" : true
    } ],
    "flags" : [ "NONE", "NONE" ],
    "name" : "name"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of users dbv0.0.39_user_info

default

User not found status

Up
get /slurmdb/v0.0.39/wckey/{wckey}
Get wckey info (slurmdbV0039GetWckey)

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" : [ "DELETED", "DELETED" ],
    "accounting" : [ {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    }, {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    } ],
    "id" : 7,
    "user" : "user"
  }, {
    "cluster" : "cluster",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "accounting" : [ {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    }, {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    } ],
    "id" : 7,
    "user" : "user"
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of wckey dbv0.0.39_wckey_info

default

wckey not found status

Up
get /slurmdb/v0.0.39/wckeys
Get wckey list (slurmdbV0039GetWckeys)

Return type

Example data

Content-Type: application/json
{
  "wckeys" : [ {
    "cluster" : "cluster",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "accounting" : [ {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    }, {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    } ],
    "id" : 7,
    "user" : "user"
  }, {
    "cluster" : "cluster",
    "name" : "name",
    "flags" : [ "DELETED", "DELETED" ],
    "accounting" : [ {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    }, {
      "start" : 6,
      "id" : 1,
      "TRES" : {
        "name" : "name",
        "count" : 6,
        "id" : 1,
        "type" : "type"
      },
      "allocated" : {
        "seconds" : 1
      }
    } ],
    "id" : 7,
    "user" : "user"
  } ],
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "errors" : [ {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  }, {
    "description" : "description",
    "source" : "source",
    "error" : "error",
    "error_number" : 5
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of wckeys dbv0.0.39_wckey_info

default

wckey not found status

Up
post /slurmdb/v0.0.39/config
Load all configuration information (slurmdbV0039SetConfig)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

dbv0.0.39_set_config dbv0.0.39_set_config (optional)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Load config status

default

Unable to set config status

Up
post /slurmdb/v0.0.39/accounts
Update accounts (slurmdbV0039UpdateAccounts)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

dbv0.0.39_account_info dbv0.0.39_account_info (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Add/update list of accounts status

default

Unable to add or update accounts status

Up
post /slurmdb/v0.0.39/associations
Set associations info (slurmdbV0039UpdateAssociations)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

dbv0.0.39_associations_info dbv0.0.39_associations_info (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

status of associations update status

default

Unable to update associations status

Up
post /slurmdb/v0.0.39/qos
Set QOS info (slurmdbV0039UpdateQos)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

dbv0.0.39_update_qos dbv0.0.39_update_qos (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

QOS update response status

default

Unable to update QOSs status

Up
post /slurmdb/v0.0.39/tres
Set TRES info (slurmdbV0039UpdateTres)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

dbv0.0.39_tres_update dbv0.0.39_tres_update (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

List of TRES status

default

Unable to update TRES status

Up
post /slurmdb/v0.0.39/users
Update user (slurmdbV0039UpdateUsers)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • application/x-yaml

Request body

dbv0.0.39_update_users dbv0.0.39_update_users (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "meta" : {
    "Slurm" : {
      "release" : "release",
      "version" : {
        "major" : 0,
        "minor" : 1,
        "micro" : 6
      }
    },
    "plugin" : {
      "name" : "name",
      "type" : "type"
    }
  },
  "warnings" : [ {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  }, {
    "warning" : "warning",
    "description" : "description",
    "source" : "source"
  } ]
}

Example data

Content-Type: application/x-yaml
Custom MIME type example not yet supported: application/x-yaml

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/json
  • application/x-yaml

Responses

200

Update users status

default

User not found or not able to update user status

Models

[ Jump to Methods ]

Table of Contents

  1. dbv0.0.39_account_info -
  2. dbv0.0.39_associations_info -
  3. dbv0.0.39_clusters_info -
  4. dbv0.0.39_config_info -
  5. dbv0.0.39_diag -
  6. dbv0.0.39_error -
  7. dbv0.0.39_job_info -
  8. dbv0.0.39_meta -
  9. dbv0.0.39_qos_info -
  10. dbv0.0.39_response_associations_delete -
  11. dbv0.0.39_set_config -
  12. dbv0.0.39_tres_info -
  13. dbv0.0.39_tres_update -
  14. dbv0.0.39_update_qos -
  15. dbv0.0.39_update_users -
  16. dbv0.0.39_user_info -
  17. dbv0.0.39_warning -
  18. dbv0.0.39_wckey_info -
  19. dbv0_0_39_meta_Slurm -
  20. dbv0_0_39_meta_Slurm_version -
  21. dbv0_0_39_meta_plugin -
  22. status -
  23. v0.0.39_account -
  24. v0.0.39_accounting -
  25. v0.0.39_acct_gather_energy -
  26. v0.0.39_assoc -
  27. v0.0.39_assoc_short -
  28. v0.0.39_assoc_usage -
  29. v0.0.39_cluster_rec -
  30. v0.0.39_controller_ping -
  31. v0.0.39_coord -
  32. v0.0.39_cron_entry -
  33. v0.0.39_diag -
  34. v0.0.39_error -
  35. v0.0.39_ext_sensors_data -
  36. v0.0.39_float64_no_val -
  37. v0.0.39_job -
  38. v0.0.39_job_desc_msg -
  39. v0.0.39_job_exit_code -
  40. v0.0.39_job_info -
  41. v0.0.39_job_res -
  42. v0.0.39_job_submission -
  43. v0.0.39_job_submission_response -
  44. v0.0.39_job_update_response -
  45. v0.0.39_jobs_response -
  46. v0.0.39_license -
  47. v0.0.39_licenses_info -
  48. v0.0.39_meta -
  49. v0.0.39_node -
  50. v0.0.39_nodes_response -
  51. v0.0.39_partition_info -
  52. v0.0.39_partitions_response -
  53. v0.0.39_pings -
  54. v0.0.39_power_mgmt_data -
  55. v0.0.39_qos -
  56. v0.0.39_reservation_core_spec -
  57. v0.0.39_reservation_info -
  58. v0.0.39_reservations_response -
  59. v0.0.39_slurm_step_id -
  60. v0.0.39_stats_msg -
  61. v0.0.39_stats_rec -
  62. v0.0.39_stats_rpc -
  63. v0.0.39_stats_user -
  64. v0.0.39_step -
  65. v0.0.39_tres -
  66. v0.0.39_uint16_no_val -
  67. v0.0.39_uint32_no_val -
  68. v0.0.39_uint64_no_val -
  69. v0.0.39_update_node_msg -
  70. v0.0.39_user -
  71. v0.0.39_warning -
  72. v0.0.39_wckey -
  73. v0.0.39_wckey_tag -
  74. v0_0_39_accounting_allocated -
  75. v0_0_39_assoc_default -
  76. v0_0_39_assoc_max -
  77. v0_0_39_assoc_max_jobs -
  78. v0_0_39_assoc_max_jobs_per -
  79. v0_0_39_assoc_min -
  80. v0_0_39_cluster_rec_associations -
  81. v0_0_39_cluster_rec_controller -
  82. v0_0_39_cron_entry_line -
  83. v0_0_39_job_array -
  84. v0_0_39_job_array_response_msg_inner -
  85. v0_0_39_job_comment -
  86. v0_0_39_job_exit_code_signal -
  87. v0_0_39_job_het -
  88. v0_0_39_job_info_power -
  89. v0_0_39_job_mcs -
  90. v0_0_39_job_required -
  91. v0_0_39_job_reservation -
  92. v0_0_39_job_state -
  93. v0_0_39_job_time -
  94. v0_0_39_job_time_user -
  95. v0_0_39_job_tres -
  96. v0_0_39_partition_info_accounts -
  97. v0_0_39_partition_info_defaults -
  98. v0_0_39_partition_info_groups -
  99. v0_0_39_partition_info_maximums -
  100. v0_0_39_partition_info_minimums -
  101. v0_0_39_partition_info_nodes -
  102. v0_0_39_partition_info_priority -
  103. v0_0_39_partition_info_qos -
  104. v0_0_39_partition_info_timeouts -
  105. v0_0_39_partition_info_tres -
  106. v0_0_39_qos_limits -
  107. v0_0_39_qos_limits_min -
  108. v0_0_39_qos_limits_min_tres -
  109. v0_0_39_qos_limits_min_tres_per -
  110. v0_0_39_qos_preempt -
  111. v0_0_39_reservation_info_purge_completed -
  112. v0_0_39_rollup_stats_inner -
  113. v0_0_39_stats_msg_rpcs_by_type_inner -
  114. v0_0_39_stats_msg_rpcs_by_user_inner -
  115. v0_0_39_stats_rpc_time -
  116. v0_0_39_step_CPU -
  117. v0_0_39_step_nodes -
  118. v0_0_39_step_statistics -
  119. v0_0_39_step_statistics_energy -
  120. v0_0_39_step_task -
  121. v0_0_39_step_tasks -
  122. v0_0_39_step_time -
  123. v0_0_39_step_time_user -
  124. v0_0_39_step_tres -
  125. v0_0_39_user_default -

dbv0.0.39_account_info - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
accounts (optional)

dbv0.0.39_associations_info - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
associations (optional)

dbv0.0.39_clusters_info - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
clusters (optional)

dbv0.0.39_config_info - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
tres (optional)
accounts (optional)
associations (optional)
users (optional)
qos (optional)
wckeys (optional)
clusters (optional)

dbv0.0.39_diag - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
statistics (optional)

dbv0.0.39_error - Up

error_number (optional)
Integer Slurm internal error number
error (optional)
String Error message
source (optional)
String Where error occurred in the source
description (optional)
String Explaination of cause of error

dbv0.0.39_job_info - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
jobs (optional)

dbv0.0.39_qos_info - Up

meta (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
errors (optional)
qos (optional)

dbv0.0.39_response_associations_delete - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
removed_associations (optional)
array[String] the associations

dbv0.0.39_set_config - Up

clusters (optional)
TRES (optional)
accounts (optional)
users (optional)
qos (optional)
wckeys (optional)
associations (optional)

dbv0.0.39_tres_info - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
tres (optional)

dbv0.0.39_user_info - Up

meta (optional)
errors (optional)
warnings (optional)
array[dbv0.0.39_warning] Slurm warnings
users (optional)

dbv0.0.39_warning - Up

warning (optional)
String Earning message
source (optional)
String Where error occurred in the source
description (optional)
String Explaination of cause of error

dbv0.0.39_wckey_info - Up

meta (optional)
errors (optional)
wckeys (optional)

dbv0_0_39_meta_Slurm - Up

Slurm information
version (optional)
release (optional)
String version specifier

dbv0_0_39_meta_Slurm_version - Up

major (optional)
micro (optional)
minor (optional)

dbv0_0_39_meta_plugin - Up

type (optional)
name (optional)

status - Up

meta (optional)
errors (optional)
warnings (optional)
array[v0.0.39_warning] Slurm warnings

v0.0.39_account - Up

associations (optional)
coordinators (optional)
description
name
organization
flags (optional)
Enum:

v0.0.39_accounting - Up

allocated (optional)
id (optional)
Integer format: int32
start (optional)
Long format: int64
TRES (optional)

v0.0.39_acct_gather_energy - Up

average_watts (optional)
Integer format: int32
base_consumed_energy (optional)
Long format: int64
consumed_energy (optional)
Long format: int64
current_watts (optional)
Integer format: int32
previous_consumed_energy (optional)
Long format: int64
last_collected (optional)
Long format: int64

v0.0.39_assoc - Up

account (optional)
cluster (optional)
default (optional)
flags (optional)
Enum:
max (optional)
is_default (optional)
min (optional)
parent_account (optional)
partition (optional)
priority (optional)
qos (optional)
array[String] List of QOS names
shares_raw (optional)
Integer format: int32
usage (optional)
user

v0.0.39_assoc_short - Up

account (optional)
cluster (optional)
partition (optional)
user

v0.0.39_assoc_usage - Up

accrue_job_count (optional)
Integer format: int32
group_used_wallclock (optional)
Double format: double
fairshare_factor (optional)
Double format: double
fairshare_shares (optional)
Integer format: int32
normalized_priority (optional)
Double format: double
normalized_shares (optional)
Double format: double
effective_normalized_usage (optional)
normalized_usage (optional)
raw_usage (optional)
active_jobs (optional)
Integer format: int32
job_count (optional)
Integer format: int32
fairshare_level (optional)

v0.0.39_cluster_rec - Up

controller (optional)
flags (optional)
Enum:
name (optional)
nodes (optional)
select_plugin (optional)
associations (optional)
rpc_version (optional)
Integer format: int32
tres (optional)

v0.0.39_controller_ping - Up

hostname (optional)
pinged (optional)
latency (optional)
Long format: int64
mode (optional)

v0.0.39_coord - Up

name
direct (optional)

v0.0.39_cron_entry - Up

flags (optional)
Enum:
minute (optional)
hour (optional)
day_of_month (optional)
month (optional)
day_of_week (optional)
specification (optional)
command (optional)
line (optional)

v0.0.39_diag - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
statistics (optional)

v0.0.39_error - Up

error_number (optional)
Integer Slurm internal error number
error (optional)
String Error message
source (optional)
String Where error occurred in the source
description (optional)
String Explaination of cause of error

v0.0.39_ext_sensors_data - Up

consumed_energy (optional)
temperature (optional)
energy_update_time (optional)
Long format: int64
current_watts (optional)
Integer format: int32

v0.0.39_float64_no_val - Up

64 bit floating point number with flags
set (optional)
Boolean True if number has been set. False if number is unset
infinite (optional)
Boolean True if number has been set to infinite. "set" and "number" will be ignored.
number (optional)
Double If set is True the number will be set with value. Otherwise ignore number contents. format: double

v0.0.39_job - Up

account (optional)
comment (optional)
allocation_nodes (optional)
Integer format: int32
array (optional)
association (optional)
block (optional)
cluster (optional)
constraints (optional)
container (optional)
derived_exit_code (optional)
time (optional)
exit_code (optional)
extra (optional)
failed_node (optional)
flags (optional)
Enum:
group (optional)
het (optional)
job_id (optional)
Integer format: int32
name (optional)
licenses (optional)
mcs (optional)
nodes (optional)
partition (optional)
priority (optional)
qos (optional)
required (optional)
kill_request_user (optional)
reservation (optional)
script (optional)
state (optional)
steps (optional)
submit_line (optional)
tres (optional)
used_gres (optional)
user (optional)
wckey (optional)
working_directory (optional)

v0.0.39_job_desc_msg - Up

account (optional)
account_gather_frequency (optional)
admin_comment (optional)
allocation_node_list (optional)
allocation_node_port (optional)
Integer format: int32
argv (optional)
array (optional)
batch_features (optional)
begin_time (optional)
Long format: int64
flags (optional)
Enum:
burst_buffer (optional)
clusters (optional)
cluster_constraint (optional)
comment (optional)
contiguous (optional)
container (optional)
container_id (optional)
core_specification (optional)
Integer format: int32
thread_specification (optional)
Integer format: int32
cpu_binding (optional)
cpu_binding_flags (optional)
Enum:
cpu_frequency (optional)
cpus_per_tres (optional)
crontab (optional)
deadline (optional)
Long format: int64
delay_boot (optional)
Integer format: int32
dependency (optional)
end_time (optional)
Long format: int64
environment (optional)
excluded_nodes (optional)
extra (optional)
constraints (optional)
group_id (optional)
hetjob_group (optional)
Integer format: int32
immediate (optional)
job_id (optional)
Integer format: int32
kill_on_node_fail (optional)
licenses (optional)
mail_type (optional)
Enum:
mail_user (optional)
mcs_label (optional)
memory_binding (optional)
memory_binding_type (optional)
Enum:
memory_per_tres (optional)
name (optional)
network (optional)
nice (optional)
Integer format: int32
tasks (optional)
Integer format: int32
open_mode (optional)
Enum:
reserve_ports (optional)
Integer format: int32
overcommit (optional)
partition (optional)
distribution_plane_size (optional)
Integer format: int32
power_flags (optional)
Enum:
prefer (optional)
priority (optional)
Integer format: int32
profile (optional)
Enum:
qos (optional)
reboot (optional)
required_nodes (optional)
requeue (optional)
reservation (optional)
script (optional)
shared (optional)
Enum:
exclusive (optional)
Enum:
site_factor (optional)
Integer format: int32
spank_environment (optional)
distribution (optional)
time_limit (optional)
time_minimum (optional)
tres_bind (optional)
tres_freq (optional)
tres_per_job (optional)
tres_per_node (optional)
tres_per_socket (optional)
tres_per_task (optional)
user_id (optional)
wait_all_nodes (optional)
kill_warning_flags (optional)
Enum:
kill_warning_signal (optional)
kill_warning_delay (optional)
current_working_directory (optional)
cpus_per_task (optional)
Integer format: int32
minimum_cpus (optional)
Integer format: int32
maximum_cpus (optional)
Integer format: int32
nodes (optional)
minimum_nodes (optional)
Integer format: int32
maximum_nodes (optional)
Integer format: int32
minimum_boards_per_node (optional)
Integer format: int32
minimum_sockets_per_board (optional)
Integer format: int32
sockets_per_node (optional)
Integer format: int32
threads_per_core (optional)
Integer format: int32
tasks_per_node (optional)
Integer format: int32
tasks_per_socket (optional)
Integer format: int32
tasks_per_core (optional)
Integer format: int32
tasks_per_board (optional)
Integer format: int32
ntasks_per_tres (optional)
Integer format: int32
minimum_cpus_per_node (optional)
Integer format: int32
memory_per_cpu (optional)
memory_per_node (optional)
temporary_disk_per_node (optional)
Integer format: int32
selinux_context (optional)
required_switches (optional)
standard_error (optional)
standard_input (optional)
standard_output (optional)
wait_for_switch (optional)
Integer format: int32
wckey (optional)
x11 (optional)
Enum:
x11_magic_cookie (optional)
x11_target_host (optional)
x11_target_port (optional)
Integer format: int32

v0.0.39_job_exit_code - Up

job exit details
status (optional)
String exit status
return_code (optional)
Integer return code (numeric) format: int32
signal (optional)

v0.0.39_job_info - Up

account (optional)
accrue_time (optional)
Long format: int64
admin_comment (optional)
allocating_node (optional)
array_job_id (optional)
array_task_id (optional)
array_max_tasks (optional)
array_task_string (optional)
association_id (optional)
Integer format: int32
batch_features (optional)
batch_flag (optional)
batch_host (optional)
flags (optional)
Enum:
burst_buffer (optional)
burst_buffer_state (optional)
cluster (optional)
cluster_features (optional)
command (optional)
comment (optional)
container (optional)
container_id (optional)
contiguous (optional)
core_spec (optional)
Integer format: int32
thread_spec (optional)
Integer format: int32
cores_per_socket (optional)
billable_tres (optional)
cpus_per_task (optional)
cpu_frequency_minimum (optional)
cpu_frequency_maximum (optional)
cpu_frequency_governor (optional)
cpus_per_tres (optional)
cron (optional)
deadline (optional)
Long format: int64
delay_boot (optional)
dependency (optional)
derived_exit_code (optional)
Integer format: int32
eligible_time (optional)
Long format: int64
end_time (optional)
Long format: int64
excluded_nodes (optional)
exit_code (optional)
Integer format: int32
extra (optional)
failed_node (optional)
features (optional)
federation_origin (optional)
federation_siblings_active (optional)
federation_siblings_viable (optional)
gres_detail (optional)
group_id (optional)
Integer format: int32
group_name (optional)
het_job_id (optional)
het_job_id_set (optional)
het_job_offset (optional)
job_id (optional)
Integer format: int32
job_resources (optional)
job_size_str (optional)
job_state (optional)
last_sched_evaluation (optional)
Long format: int64
licenses (optional)
mail_type (optional)
Enum:
mail_user (optional)
max_cpus (optional)
max_nodes (optional)
mcs_label (optional)
memory_per_tres (optional)
name (optional)
network (optional)
nodes (optional)
nice (optional)
Integer format: int32
tasks_per_core (optional)
tasks_per_tres (optional)
tasks_per_node (optional)
tasks_per_socket (optional)
tasks_per_board (optional)
cpus (optional)
node_count (optional)
tasks (optional)
partition (optional)
prefer (optional)
memory_per_cpu (optional)
memory_per_node (optional)
minimum_cpus_per_node (optional)
minimum_tmp_disk_per_node (optional)
power (optional)
preempt_time (optional)
Long format: int64
preemptable_time (optional)
Long format: int64
pre_sus_time (optional)
Long format: int64
priority (optional)
profile (optional)
Enum:
qos (optional)
reboot (optional)
required_nodes (optional)
minimum_switches (optional)
Integer format: int32
requeue (optional)
resize_time (optional)
Long format: int64
restart_cnt (optional)
Integer format: int32
resv_name (optional)
scheduled_nodes (optional)
selinux_context (optional)
shared (optional)
Enum:
exclusive (optional)
Enum:
show_flags (optional)
Enum:
sockets_per_board (optional)
Integer format: int32
sockets_per_node (optional)
start_time (optional)
Long format: int64
state_description (optional)
state_reason (optional)
standard_error (optional)
standard_input (optional)
standard_output (optional)
submit_time (optional)
Long format: int64
suspend_time (optional)
Long format: int64
system_comment (optional)
time_limit (optional)
time_minimum (optional)
threads_per_core (optional)
tres_bind (optional)
tres_freq (optional)
tres_per_job (optional)
tres_per_node (optional)
tres_per_socket (optional)
tres_per_task (optional)
tres_req_str (optional)
tres_alloc_str (optional)
user_id (optional)
Integer format: int32
user_name (optional)
maximum_switch_wait_time (optional)
Integer format: int32
wckey (optional)
current_working_directory (optional)

v0.0.39_job_res - Up

nodes (optional)
allocated_cores (optional)
Integer format: int32
allocated_cpus (optional)
Integer format: int32
allocated_hosts (optional)
Integer format: int32
allocated_nodes (optional)
array[oas_any_type_not_mapped] job node resources

v0.0.39_job_submission - Up

script (optional)
String Executable script (full contents) to run in batch step for all job components
job (optional)
jobs (optional)

v0.0.39_job_submission_response - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
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.39_job_update_response - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
results (optional)

v0.0.39_jobs_response - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
jobs (optional)

v0.0.39_license - Up

LicenseName (optional)
Total (optional)
Integer format: int32
Used (optional)
Integer format: int32
Free (optional)
Integer format: int32
Remote (optional)
Reserved (optional)
Integer format: int32
LastConsumed (optional)
Integer format: int32
LastDeficit (optional)
Integer format: int32
LastUpdate (optional)
Long format: int64

v0.0.39_licenses_info - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
licenses (optional)

v0.0.39_node - Up

architecture (optional)
burstbuffer_network_address (optional)
boards (optional)
Integer format: int32
boot_time (optional)
Long format: int64
cluster_name (optional)
cores (optional)
Integer format: int32
specialized_cores (optional)
Integer format: int32
cpu_binding (optional)
Integer format: int32
cpu_load (optional)
free_mem (optional)
cpus (optional)
Integer format: int32
effective_cpus (optional)
Integer format: int32
specialized_cpus (optional)
energy (optional)
external_sensors (optional)
extra (optional)
power (optional)
features (optional)
active_features (optional)
gres (optional)
gres_drained (optional)
gres_used (optional)
last_busy (optional)
Long format: int64
mcs_label (optional)
specialized_memory (optional)
Long format: int64
name (optional)
next_state_after_reboot (optional)
Enum:
address (optional)
hostname (optional)
state (optional)
Enum:
operating_system (optional)
owner (optional)
partitions (optional)
port (optional)
Integer format: int32
real_memory (optional)
Long format: int64
comment (optional)
reason (optional)
reason_changed_at (optional)
Long format: int64
reason_set_by_user (optional)
resume_after (optional)
reservation (optional)
alloc_memory (optional)
Long format: int64
alloc_cpus (optional)
Integer format: int32
alloc_idle_cpus (optional)
Integer format: int32
tres_used (optional)
tres_weighted (optional)
Double format: double
slurmd_start_time (optional)
Long format: int64
sockets (optional)
Integer format: int32
threads (optional)
Integer format: int32
temporary_disk (optional)
Integer format: int32
weight (optional)
Integer format: int32
tres (optional)
version (optional)

v0.0.39_nodes_response - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
nodes (optional)

v0.0.39_partition_info - Up

nodes (optional)
accounts (optional)
groups (optional)
qos (optional)
alternate (optional)
tres (optional)
cluster (optional)
cpus (optional)
defaults (optional)
grace_time (optional)
Integer format: int32
maximums (optional)
minimums (optional)
name (optional)
node_sets (optional)
priority (optional)
timeouts (optional)
suspend_time (optional)

v0.0.39_partitions_response - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
partitions (optional)

v0.0.39_pings - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
pings (optional)

v0.0.39_power_mgmt_data - Up

maximum_watts (optional)
current_watts (optional)
Integer format: int32
total_energy (optional)
Long format: int64
new_maximum_watts (optional)
Integer format: int32
peak_watts (optional)
Integer format: int32
lowest_watts (optional)
Integer format: int32
new_job_time (optional)
Long format: int64
state (optional)
Integer format: int32
time_start_day (optional)
Long format: int64

v0.0.39_qos - Up

description (optional)
flags (optional)
Enum:
id (optional)
Integer format: int32
limits (optional)
name (optional)
preempt (optional)
priority (optional)
Integer format: int32
usage_factor (optional)
usage_threshold (optional)

v0.0.39_reservation_core_spec - Up

node (optional)
core (optional)

v0.0.39_reservation_info - Up

accounts (optional)
burst_buffer (optional)
core_count (optional)
Integer format: int32
core_specializations (optional)
end_time (optional)
Long format: int64
features (optional)
flags (optional)
Enum:
groups (optional)
licenses (optional)
max_start_delay (optional)
Integer format: int32
name (optional)
node_count (optional)
Integer format: int32
node_list (optional)
partition (optional)
purge_completed (optional)
start_time (optional)
Long format: int64
watts (optional)
tres (optional)
users (optional)

v0.0.39_reservations_response - Up

meta (optional)
errors (optional)
array[v0.0.39_error] Slurm errors
warnings (optional)
array[v0.0.39_warning] Slurm warnings
reservations (optional)

v0.0.39_slurm_step_id - Up

step details
job_id (optional)
Integer JobID format: int32
step_het_component (optional)
Integer HetStep format: int32
step_id (optional)

v0.0.39_stats_msg - Up

parts_packed (optional)
Integer format: int32
req_time (optional)
Long format: int64
req_time_start (optional)
Long format: int64
server_thread_count (optional)
Integer format: int32
agent_queue_size (optional)
Integer format: int32
agent_count (optional)
Integer format: int32
agent_thread_count (optional)
Integer format: int32
dbd_agent_queue_size (optional)
Integer format: int32
gettimeofday_latency (optional)
Integer format: int32
schedule_cycle_max (optional)
Integer format: int32
schedule_cycle_last (optional)
Integer format: int32
schedule_cycle_total (optional)
Integer format: int32
schedule_cycle_mean (optional)
Long format: int64
schedule_cycle_mean_depth (optional)
Long format: int64
schedule_cycle_per_minute (optional)
Long format: int64
schedule_queue_length (optional)
Integer format: int32
jobs_submitted (optional)
Integer format: int32
jobs_started (optional)
Integer format: int32
jobs_completed (optional)
Integer format: int32
jobs_canceled (optional)
Integer format: int32
jobs_failed (optional)
Integer format: int32
jobs_pending (optional)
Integer format: int32
jobs_running (optional)
Integer format: int32
job_states_ts (optional)
Long format: int64
bf_backfilled_jobs (optional)
Integer format: int32
bf_last_backfilled_jobs (optional)
Integer format: int32
bf_backfilled_het_jobs (optional)
Integer format: int32
bf_cycle_counter (optional)
Integer format: int32
bf_cycle_mean (optional)
Long format: int64
bf_depth_mean (optional)
Long format: int64
bf_depth_mean_try (optional)
Long format: int64
bf_cycle_sum (optional)
Long format: int64
bf_cycle_last (optional)
Integer format: int32
bf_last_depth (optional)
Integer format: int32
bf_last_depth_try (optional)
Integer format: int32
bf_depth_sum (optional)
Integer format: int32
bf_depth_try_sum (optional)
Integer format: int32
bf_queue_len (optional)
Integer format: int32
bf_queue_len_mean (optional)
Long format: int64
bf_queue_len_sum (optional)
Integer format: int32
bf_table_size (optional)
Integer format: int32
bf_table_size_mean (optional)
Long format: int64
bf_when_last_cycle (optional)
Long format: int64
bf_active (optional)
rpcs_by_message_type (optional)
rpcs_by_user (optional)

v0.0.39_stats_rec - Up

time_start (optional)
Long format: int64
rollups (optional)
array[v0_0_39_rollup_stats_inner] list of recorded rollup statistics
RPCs (optional)
users (optional)

v0.0.39_stats_rpc - Up

rpc (optional)
count (optional)
Integer format: int32
time (optional)

v0.0.39_stats_user - Up

user (optional)
count (optional)
Integer format: int32
time (optional)

v0.0.39_step - Up

time (optional)
exit_code (optional)
nodes (optional)
tasks (optional)
pid (optional)
CPU (optional)
kill_request_user (optional)
state (optional)
statistics (optional)
step (optional)
task (optional)
tres (optional)

v0.0.39_tres - Up

type
name (optional)
id (optional)
Integer format: int32
count (optional)
Long format: int64

v0.0.39_uint16_no_val - Up

Integer number with flags
set (optional)
Boolean True if number has been set. False if number is unset
infinite (optional)
Boolean True if number has been set to infinite. "set" and "number" will be ignored.
number (optional)
Long If set is True the number will be set with value. Otherwise ignore number contents. format: int64

v0.0.39_uint32_no_val - Up

Integer number with flags
set (optional)
Boolean True if number has been set. False if number is unset
infinite (optional)
Boolean True if number has been set to infinite. "set" and "number" will be ignored.
number (optional)
Long If set is True the number will be set with value. Otherwise ignore number contents. format: int64

v0.0.39_uint64_no_val - Up

Integer number with flags
set (optional)
Boolean True if number has been set. False if number is unset
infinite (optional)
Boolean True if number has been set to infinite. "set" and "number" will be ignored.
number (optional)
Long If set is True the number will be set with value. Otherwise ignore number contents. format: int64

v0.0.39_update_node_msg - Up

comment (optional)
cpu_bind (optional)
Integer format: int32
extra (optional)
features (optional)
features_act (optional)
gres (optional)
address (optional)
hostname (optional)
name (optional)
state (optional)
Enum:
reason (optional)
reason_uid (optional)
resume_after (optional)
weight (optional)

v0.0.39_user - Up

administrator_level (optional)
Enum:
associations (optional)
coordinators (optional)
default (optional)
flags (optional)
Enum:
name
old_name (optional)
wckeys (optional)

v0.0.39_warning - Up

warning (optional)
String Earning message
source (optional)
String Where error occurred in the source
description (optional)
String Explaination of cause of error

v0.0.39_wckey - Up

accounting (optional)
cluster
id (optional)
Integer format: int32
name
user
flags (optional)
Enum:

v0.0.39_wckey_tag - Up

wckey details
wckey (optional)
String wckey
flags (optional)
array[String] active flags
Enum:

v0_0_39_accounting_allocated - Up

seconds (optional)
Long format: int64

v0_0_39_assoc_min - Up

priority_threshold (optional)

v0_0_39_cluster_rec_controller - Up

port (optional)
Integer format: int32

v0_0_39_cron_entry_line - Up

end (optional)
Integer format: int32

v0_0_39_job_array_response_msg_inner - Up

ArrayJob
job_id (optional)
Integer JobId format: int32
error_code (optional)
Integer numeric error code format: int32
error (optional)
String error code description
why (optional)
String error message

v0_0_39_job_comment - Up

system (optional)

v0_0_39_job_exit_code_signal - Up

Job exited due to signal
signal_id (optional)
Integer signal numeric ID format: int32
name (optional)
String signal name

v0_0_39_job_mcs - Up

label (optional)

v0_0_39_job_required - Up

memory (optional)
Long format: int64

v0_0_39_job_state - Up

reason (optional)

v0_0_39_job_time_user - Up

microseconds (optional)
Long format: int64

v0_0_39_partition_info_minimums - Up

nodes (optional)
Integer format: int32

v0_0_39_partition_info_nodes - Up

total (optional)
Integer format: int32

v0_0_39_partition_info_priority - Up

tier (optional)
Integer format: int32

v0_0_39_rollup_stats_inner - Up

recorded rollup statistics
type (optional)
String type
Enum:
internal
user
unknown
last run (optional)
Integer Last time rollup ran (UNIX timestamp) format: int32
max_cycle (optional)
Long longest rollup time (seconds) format: int64
total_time (optional)
Long total time spent doing rollups (seconds) format: int64
total_cycles (optional)
Long number of rollups since last_run format: int64
mean_cycles (optional)
Long average time for rollup (seconds) format: int64

v0_0_39_stats_msg_rpcs_by_type_inner - Up

RPC
message_type (optional)
String Message type as string
type_id (optional)
Integer Message type as integer format: int32
count (optional)
Long Number of RPCs received format: int64
average_time (optional)
Long Average time spent processing RPC in seconds format: int64
total_time (optional)
Long Total time spent processing RPC in seconds format: int64

v0_0_39_stats_msg_rpcs_by_user_inner - Up

user
user (optional)
String user name
user_id (optional)
Integer user id (numeric) format: int32
count (optional)
Long Number of RPCs received format: int64
average_time (optional)
Long Average time spent processing RPC in seconds format: int64
total_time (optional)
Long Total time spent processing RPC in seconds format: int64

v0_0_39_stats_rpc_time - Up

total (optional)
Long format: int64

v0_0_39_step_CPU - Up

governor (optional)

v0_0_39_step_task - Up

distribution (optional)

v0_0_39_step_tasks - Up

count (optional)
Integer format: int32

v0_0_39_step_time_user - Up

microseconds (optional)
Integer format: int32