Compute

The Compute API provides access to SLURM job scheduling on select OLCF resources. The implementation is “SLURM Indirect”—it mirrors the official SLURM REST API structure.

Required Permission: compute-ace or compute-ace-readonly

Note

The Python and Go examples on this page use gRPC client packages that are not yet publicly available. ORNL-internal users may request access by contacting OLCF Support: help@olcf.ornl.gov. The REST API (via curl or otherwise) is available to all users.

Available Resources

The public compute API versions currently differ by resource.

Public SLURM API versions

Resource

Public versions

defiant

v0.0.42, v0.0.43

odo

v0.0.43, v0.0.44

wombat

v0.0.42

quokka

v0.0.42

Note

For the request and response examples on this page, v0.0.42 and v0.0.43 are effectively the same, so this page focuses on v0.0.43 and v0.0.44. The main user-visible v0.0.42 / v0.0.43 difference is that the ping metadata version fields are strings in v0.0.43.

Note

API version v0.0.42 endpoints remain available but are deprecated. Migrate to v0.0.43 for full compatibility with SLURM 25.05.

Ping Resource

Check the health status of a compute resource.

GET /slurm/open/v0.0.43/{resource}/ping

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/ping

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
pong = await client.ping(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
pong, err := client.Ping(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"

# This sets the Authorization header like the curl example
headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/ping",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

GET /slurm/open/v0.0.44/{resource}/ping

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/ping

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
pong = await client.ping(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
pong, err := client.Ping(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"

headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/ping",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

List Partitions

Get available partitions (queues) on a resource.

GET /slurm/open/v0.0.43/{resource}/partitions

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/partitions

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
partitions = await client.get_partitions(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
partitions, err := client.GetPartitions(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"

# This sets the Authorization header like the curl example
headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/partitions",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "partitions": [
        {
          "name": "batch-cpu",
          "cluster": "defiant",
          "nodes": {
                "allowed_configuration": "node[001-128]",
                "configured": "node[001-128]",
                "total": 128
          },
          "defaults": {
                "time": {"number": 60, "set": true}
          },
          "maximums": {
                "nodes": {"number": 4, "set": true}
          },
          "priority": {
                "tier": 1000
          }
        }
  ]
}

GET /slurm/open/v0.0.44/{resource}/partitions

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/partitions

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
partitions = await client.get_partitions(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
partitions, err := client.GetPartitions(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"

headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/partitions",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "partitions": [
        {
          "name": "batch-cpu",
          "cluster": "odo",
          "nodes": {
                "allowed_allocation": "node[001-128]",
                "configured": "node[001-128]",
                "total": 128
          },
          "defaults": {
                "time": {"number": 60, "set": true}
          },
          "maximums": {
                "nodes": {"number": 4, "set": true}
          },
          "priority": {
                "tier": 1000
          },
          "topology": "block"
        }
  ]
}

Submit a Job

Submit a new batch job to the scheduler.

POST /slurm/open/v0.0.43/{resource}/job/submit

curl -X POST -H @.env \
        -H "Content-Type: application/json" \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/job/submit \
        -d '{
          "job": {
                 "name": "my-job",
                 "account": "STF040",
                 "partition": "batch-cpu",
                 "minimum_nodes": 1,
                 "tasks": 1,
                 "time_limit": {"number": 60, "set": true},
                 "current_working_directory": "/lustre/polis/stf040/scratch/user",
                 "environment": ["PATH=/usr/bin"],
                 "script": "#!/bin/bash\necho Hello World"
          }
        }'

from s3m_apis_betterproto.slurm.v0043 import JobSubmitReq, JobSubmitReqJobDescription, Uint32NoVal

client = factory.create_client(SlurmIndirectStub)
result = await client.post_job_submit(JobSubmitReq(
        job=JobSubmitReqJobDescription(
                name="my-job",
                account="STF040",
                partition="batch-cpu",
                minimum_nodes=1,
                tasks=1,
                time_limit=Uint32NoVal(number=60, set=True),
                current_working_directory="/lustre/polis/stf040/scratch/user",
                environment=["PATH=/usr/bin"],
                script="#!/bin/bash\necho Hello World"
        )
))

import (
        "context"
        "google.golang.org/protobuf/proto"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
result, err := client.PostJobSubmit(context.Background(), &slurmv0043pb.JobSubmitReq{
        Job: &slurmv0043pb.JobSubmitReq_JobDescription{
                Name:                    "my-job",
                Account:                 "STF040",
                Partition:               "batch-cpu",
                MinimumNodes:            proto.Int32(1),
                Tasks:                   proto.Int32(1),
                TimeLimit:               &slurmv0043pb.Uint32NoVal{Number: 60, Set: true},
                CurrentWorkingDirectory: "/lustre/polis/stf040/scratch/user",
                Environment:             []string{"PATH=/usr/bin"},
                Script:                  "#!/bin/bash\necho Hello World",
        },
})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"

headers = {
        "Authorization": S3M_TOKEN,
        "Content-Type: application/json"
}

# This section defines the job to submit
payload = {
        "job": {
                "name": "my-job",
                "account": "STF040",
                "partition": "batch-cpu",
                "minimum_nodes": 1,
                "tasks": 1,
                "time_limit": {"number": 60, "set": true},
                "current_working_directory": "/lustre/polis/stf040/scratch/user",
                "environment": ["PATH=/usr/bin"],
                "script": "#!/bin/bash\necho Hello World"
        }
}

response = requests.post(
        f"{S3M_BASE_PATH}/{resource}/job/submit",
        headers=headers,
        data=payload,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

POST /slurm/open/v0.0.44/{resource}/job/submit

curl -X POST -H @.env \
        -H "Content-Type: application/json" \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/job/submit \
        -d '{
          "script": "#!/bin/bash\necho Hello World",
          "jobs": [
                 {
                        "name": "my-job",
                        "account": "STF040",
                        "partition": "batch-cpu",
                        "minimum_nodes": 1,
                        "tasks": 1,
                        "time_limit": {"number": 60, "set": true},
                        "current_working_directory": "/lustre/polis/stf040/scratch/user",
                        "environment": ["PATH=/usr/bin"]
                 }
          ]
        }'

from s3m_apis_betterproto.slurm.v0044 import JobSubmitReq, JobSubmitReqJobDescription, Uint32NoVal

client = factory.create_client(SlurmIndirectStub)
result = await client.post_job_submit(JobSubmitReq(
        script="#!/bin/bash\necho Hello World",
        jobs=[
                JobSubmitReqJobDescription(
                        name="my-job",
                        account="STF040",
                        partition="batch-cpu",
                        minimum_nodes=1,
                        tasks=1,
                        time_limit=Uint32NoVal(number=60, set=True),
                        current_working_directory="/lustre/polis/stf040/scratch/user",
                        environment=["PATH=/usr/bin"],
                )
        ],
))

import (
        "context"
        "google.golang.org/protobuf/proto"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
result, err := client.PostJobSubmit(context.Background(), &slurmv0044pb.JobSubmitReq{
        Script: "#!/bin/bash\necho Hello World",
        Jobs: []*slurmv0044pb.JobSubmitReq_JobDescription{
                {
                        Name:                    "my-job",
                        Account:                 "STF040",
                        Partition:               "batch-cpu",
                        MinimumNodes:            proto.Int32(1),
                        Tasks:                   proto.Int32(1),
                        TimeLimit:               &slurmv0044pb.Uint32NoVal{Number: 60, Set: true},
                        CurrentWorkingDirectory: "/lustre/polis/stf040/scratch/user",
                        Environment:             []string{"PATH=/usr/bin"},
                },
        },
})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"

headers = {
        "Authorization": S3M_TOKEN,
        "Content-Type": "application/json",
}

payload = {
        "script": "#!/bin/bash\necho Hello World",
        "jobs": [
                {
                        "name": "my-job",
                        "account": "STF040",
                        "partition": "batch-cpu",
                        "minimum_nodes": 1,
                        "tasks": 1,
                        "time_limit": {"number": 60, "set": true},
                        "current_working_directory": "/lustre/polis/stf040/scratch/user",
                        "environment": ["PATH=/usr/bin"],
                }
        ],
}

response = requests.post(
        f"{S3M_BASE_PATH}/{resource}/job/submit",
        headers=headers,
        json=payload,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Existing single-job job payloads also remain valid in v0.0.44:

{
        "job": {
                "name": "my-job",
                "account": "STF040",
                "partition": "batch-cpu",
                "minimum_nodes": 1,
                "tasks": 1,
                "time_limit": {"number": 60, "set": true},
                "current_working_directory": "/lustre/polis/stf040/scratch/user",
                "environment": ["PATH=/usr/bin"],
                "script": "#!/bin/bash\\necho Hello World"
        }
}

Do not send both job and jobs in the same request.

Response:

{
  "job_id": 12345,
  "step_id": "batch"
}

Get Job Status

Retrieve details about a specific job.

GET /slurm/open/v0.0.43/{resource}/job/{job_id}

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/job/12345

from s3m_apis_betterproto.slurm.v0043 import JobIdReq

client = factory.create_client(SlurmIndirectStub)
job = await client.get_job(JobIdReq(job_id="12345"))

import (
        "context"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
job, err := client.GetJob(context.Background(), &slurmv0043pb.JobIdReq{JobId: "12345"})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"
job_id = "12345"

# This sets the Authorization header like the curl example
headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/job/{job_id}",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

GET /slurm/open/v0.0.44/{resource}/job/{job_id}

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/job/12345

from s3m_apis_betterproto.slurm.v0044 import JobIdReq

client = factory.create_client(SlurmIndirectStub)
job = await client.get_job(JobIdReq(job_id="12345"))

import (
        "context"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
job, err := client.GetJob(context.Background(), &slurmv0044pb.JobIdReq{JobId: "12345"})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"
job_id = "12345"

headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/job/{job_id}",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "jobs": [
        {
          "job_id": 12345,
          "name": "my-job",
          "account": "STF040",
          "partition": "batch-cpu",
          "user": "alice",
          "gruop": "users",
          "nodes": "node001",
          "state": {
                "current": ["RUNNING"],
                "reason": "None"
          },
          "time": {
                "start": 1741827600,
                "elapsed": 95
          },
          "required": {
                "CPUs": 4
          },
          "steps": [
                {
                  "step": {
                        "id": "batch",
                        "name": "batch"
                  },
                  "state": ["RUNNING"]
                }
          ]
        }
  ]
}

List All Jobs

Retrieve all jobs visible to your project.

GET /slurm/open/v0.0.43/{resource}/jobs

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/jobs

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
jobs = await client.get_jobs(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
jobs, err := client.GetJobs(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"

# This sets the Authorization header like the curl example
headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/jobs",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "jobs": [
        {
          "job_id": 12345,
          "name": "my-job",
          "account": "STF040",
          "partition": "batch-cpu",
          "job_state": ["RUNNING"],
          "node_count": {"number": 1, "set": true},
          "tasks": {"number": 4, "set": true},
          "job_resources": {
                "cpus": 4,
                "nodes": {
                  "count": 1,
                  "list": "node001",
                  "whole": true,
                  "job_resources": ["cpu=4", "mem=0"]
                }
          }
        }
  ]
}

GET /slurm/open/v0.0.44/{resource}/jobs

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/jobs

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
jobs = await client.get_jobs(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
jobs, err := client.GetJobs(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"

headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/jobs",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
 "jobs": [
       {
         "job_id": 12345,
         "name": "my-job",
         "account": "STF040",
         "partition": "batch-cpu",
         "job_state": ["RUNNING"],
         "node_count": {"number": 1, "set": true},
         "tasks": {"number": 4, "set": true},
         "job_resources": {
               "cpus": 4,
               "nodes": {
                 "count": 1,
                 "list": "node001",
                 "whole": true,
                 "select_type": ["CR_CORE"]
               }
         }
       }
 ]
}

Cancel a Job

Cancel a running or pending job.

DELETE /slurm/open/v0.0.43/{resource}/job/{job_id}

curl -X DELETE -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/job/12345

from s3m_apis_betterproto.slurm.v0043 import DeleteJobReq

client = factory.create_client(SlurmIndirectStub)
await client.delete_job(DeleteJobReq(job_id="12345"))

import (
        "context"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
_, err := client.DeleteJob(context.Background(), &slurmv0043pb.DeleteJobReq{JobId: "12345"})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"
job_id = "12345"

# This sets the Authorization header like the curl example
headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.delete(
        f"{S3M_BASE_PATH}/{resource}/job/{job_id}",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

DELETE /slurm/open/v0.0.44/{resource}/job/{job_id}

curl -X DELETE -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/job/12345

from s3m_apis_betterproto.slurm.v0044 import DeleteJobReq

client = factory.create_client(SlurmIndirectStub)
await client.delete_job(DeleteJobReq(job_id="12345"))

import (
        "context"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
_, err := client.DeleteJob(context.Background(), &slurmv0044pb.DeleteJobReq{JobId: "12345"})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"
job_id = "12345"

headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.delete(
        f"{S3M_BASE_PATH}/{resource}/job/{job_id}",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Optional Parameters:

  • signal — Signal to send (e.g., SIGTERM, SIGKILL). Default is SIGTERM.

  • flags — Additional flags for job cancellation.

List Nodes

Get information about compute nodes on a resource.

GET /slurm/open/v0.0.43/{resource}/nodes

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/nodes

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
nodes = await client.get_nodes(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
nodes, err := client.GetNodes(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"

# This sets the Authorization header like the curl example
headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/nodes",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "nodes": [
        {
          "name": "node001"
        }
  ]
}

GET /slurm/open/v0.0.44/{resource}/nodes

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/nodes

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
nodes = await client.get_nodes(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
nodes, err := client.GetNodes(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"

headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/nodes",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "nodes": [
        {
          "name": "node001",
          "tls_cert_last_renewal": {"number": 1741824000, "set": true},
          "cert_flags": ["..."],
          "topology": "..."
        }
  ]
}

List Reservations

Get reservations on a resource.

GET /slurm/open/v0.0.43/{resource}/reservations

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/reservations

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
reservations = await client.get_reservations(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
reservations, err := client.GetReservations(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"

# This sets the Authorization header like the curl example
headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/reservations",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "reservations": [
        {
          "name": "maintenance-window",
          "partition": "batch-cpu",
          "node_list": "node[001-004]",
          "node_count": 4,
          "core_specializations": ["node001:0"],
          "start_time": {"number": 1741824000, "set": true},
          "end_time": {"number": 1741827600, "set": true},
          "purge_completed": {"number": 60, "set": true}
        }
  ]
}

GET /slurm/open/v0.0.44/{resource}/reservations

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/reservations

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
reservations = await client.get_reservations(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
reservations, err := client.GetReservations(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"

headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/reservations",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "reservations": [
        {
          "name": "maintenance-window",
          "partition": "batch-cpu",
          "node_list": "node[001-004]",
          "node_count": 4,
          "core_specializations": [
                {"node": "node001", "core": "0"}
          ],
          "start_time": {"number": 1741824000, "set": true},
          "end_time": {"number": 1741827600, "set": true},
          "purge_completed": {
                "time": {"number": 60, "set": true}
          }
        }
  ]
}

Scheduler Diagnostics

Get diagnostic information about the SLURM scheduler.

GET /slurm/open/v0.0.43/{resource}/diag

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.43/defiant/diag

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
diag = await client.get_diag(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0043pb "s3m.olcf.ornl.gov/apis/slurm/v0043"
)

client := slurmv0043pb.NewSlurmIndirectClient(conn)
diag, err := client.GetDiag(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.43"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "defiant"

# This sets the Authorization header like the curl example
headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/diag",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "statistics": {
        "schedule_exit": {
          "defult_queue_depth": 128
        }
  }
}

GET /slurm/open/v0.0.44/{resource}/diag

curl -H @.env \
        https://s3m.olcf.ornl.gov/slurm/open/v0.0.44/odo/diag

from betterproto.lib.std.google.protobuf import Empty

client = factory.create_client(SlurmIndirectStub)
diag = await client.get_diag(Empty())

import (
        "context"
        "google.golang.org/protobuf/types/known/emptypb"
        slurmv0044pb "s3m.olcf.ornl.gov/apis/slurm/v0044"
)

client := slurmv0044pb.NewSlurmIndirectClient(conn)
diag, err := client.GetDiag(context.Background(), &emptypb.Empty{})

import os
import requests

S3M_BASE_PATH = "https://s3m.olcf.ornl.gov/slurm/open/v0.0.44"
S3M_TOKEN = os.getenv("S3M_TOKEN")
resource = "odo"

headers = {
        "Authorization": S3M_TOKEN,
}

response = requests.get(
        f"{S3M_BASE_PATH}/{resource}/diag",
        headers=headers,
)

if response.ok:
        compute_response = response.json()
        print(compute_response)
else:
        raise ValueError("Request to S3M failed")

Response:

{
  "statistics": {
        "schedule_cycle_depth": 42,
        "bf_table_size_sum": 84,
        "schedule_exit": {
          "default_queue_depth": 128
        }
  }
}

References

For full request/response details, see the SLURM REST API documentation.