Developer.TACC.cloud

Developer documentation for Agave, Abaco, and other TACC APIs

Stopping

Once your job is submitted, you have the ability to stop the job. This will kill the job on the system on which it is running.

You can kill a job with the following CLI command:

jobs-stop $JOB_ID

Show cURL   

curl -sk -H "Authorization: Bearer $ACCESS_TOKEN" -X POST -d "action=kill" https://agave.iplantc.org/jobs/v2/$JOB_ID

Show response   

{
 "id" : "$JOB_ID",
 "name" : "demo-pyplot-demo-advanced test-1414139896",
 "owner" : "$API_USERNAME",
 "appId" : "demo-pyplot-demo-advanced-0.1.0",
 "executionSystem" : "$PUBLIC_EXECUTION_SYSTEM",
 "batchQueue" : "debug",
 "nodeCount" : 1,
 "processorsPerNode" : 1,
 "memoryPerNode" : 1.0,
 "maxRunTime" : "01:00:00",
 "archive" : false,
 "retries" : 0,
 "localId" : "10321",
 "outputPath" : null,
 "status" : "STOPPED",
 "submitTime" : "2014-10-24T04:48:11.000-05:00",
 "startTime" : "2014-10-24T04:48:08.000-05:00",
 "endTime" : null,
 "inputs" : {
   "dataset" : "agave://$PUBLIC_STORAGE_SYSTEM/$API_USERNAME/inputs/pyplot/testdata.csv"
 },
 "parameters" : {
   "chartType" : "bar",
   "height" : "512",
   "showLegend" : "false",
   "xlabel" : "Time",
   "background" : "#FFF",
   "width" : "1024",
   "showXLabel" : "true",
   "separateCharts" : "false",
   "unpackInputs" : "false",
   "ylabel" : "Magnitude",
   "showYLabel" : "true"
 },
 "_links" : {
   "self" : {
     "href" : "https://public.tenants.agaveapi.co/jobs/v2/0001414144065563-5056a550b8-0001-007"
   },
   "app" : {
     "href" : "https://public.tenants.agaveapi.co/apps/v2/demo-pyplot-demo-advanced-0.1.0"
   },
   "executionSystem" : {
     "href" : "https://public.tenants.agaveapi.co/systems/v2/$PUBLIC_EXECUTION_SYSTEM"
   },
   "archiveData" : {
     "href" : "https://public.tenants.agaveapi.co/jobs/v2/0001414144065563-5056a550b8-0001-007/outputs/listings"
   },
   "owner" : {
     "href" : "https://public.tenants.agaveapi.co/profiles/v2/$API_USERNAME"
   },
   "permissions" : {
     "href" : "https://public.tenants.agaveapi.co/jobs/v2/0001414144065563-5056a550b8-0001-007/pems"
   },
   "history" : {
     "href" : "https://public.tenants.agaveapi.co/jobs/v2/0001414144065563-5056a550b8-0001-007/history"
   },
   "metadata" : {
     "href" : "https://public.tenants.agaveapi.co/meta/v2/data/?q={"associationIds":"0001414144065563-5056a550b8-0001-007"}"
   },
   "notifications" : {
     "href" : "https://public.tenants.agaveapi.co/notifications/v2/?associatedUuid=0001414144065563-5056a550b8-0001-007"
   }
 }
}

Deleting a job

Over time the number of jobs you have run can grow rather large. You can delete jobs to remove them from your listing results, with the following CLI command:

jobs-delete $JOB_ID

Show cURL   

curl -sk -H "Authorization: Bearer $ACCESS_TOKEN" -X DELETE https://agave.iplantc.org/jobs/v2/$JOB_ID

:warning: Deleting a job will hide it from view, not permanently delete the record.

Resubmitting a job

Often times you will want to rerun a previous job as part of a pipeline, automation, or validation that the results were valid. In this situation, it is convenient to use the resubmit feature of the Jobs service.

jobs-resubmit $JOB_ID

Show cURL   

curl -sk -H "Authorization: Bearer $ACCESS_TOKEN" -X POST -d "action=resubmit" https://agave.iplantc.org/jobs/v2/$JOB_ID

Resubmission provides you the options to enforce as much or as little rigor as you desire with respect to reproducibility in the job submission process. The following options are available to you for configuring a resubmission according to your requirements.

Field Type Description
ignoreInputConflicts boolean Whether to ignore discrepencies in the previous app inputs for the resubmitted job. If true, the resubmitted job will make a best fit attempt and migrating the inputs.
ignoreParameterConflicts boolean Whether to ignore discrepencies in the previous app parameters for the resubmitted job. If true, the resubmitted job will make a best fit attempt and migrating the parameters.
preserveNotifications boolean Whether to recreate the notification of the original job for the resubmitted job.