Actions (Slurm)

Cedana API for actions (Slurm)

Checkpoint job

post

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

action_idstring | nullRead-onlyOptional

job_idstring | nullOptional

job_namestring | nullOptional

kindstring · enumOptionalPossible values:

reasonstring · enumOptionalPossible values:

Responses

200

Returns the id for the task

text/plain

Responsestring

404

Failed to find checkpointable resource

text/plain

500

Failed to connect/fetch from jobs table from database

text/plain

post

/v2/slurm/checkpoint/job

HTTPcURLJavaScriptPython

POST /v2/slurm/checkpoint/job HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "job_id": null,
  "job_name": null,
  "kind": "simple",
  "reason": "heartbeat"
}

<uuid-v4-here>

Restore job

post

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

action_idstringRequired

cluster_idstringRequired

reasonstring · enumRequiredPossible values:

Responses

200

Returns the checkpoint id for the new checkpoint

text/plain

Responsestring

400

Failed create checkpoint

text/plain

404

Failed create restore

text/plain

500

Failed to connect/fetch from jobs table from database

text/plain

post

/v2/slurm/restore/job

HTTPcURLJavaScriptPython

POST /v2/slurm/restore/job HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "action_id": "text",
  "cluster_id": "text",
  "reason": "nodeTermination"
}

<uuid-v4-here>