Jobs
get/api/v1/jobs/{name}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/jobs/{name}
  • Auth: none declared

Path parameters

namestring required

Headers

X-Axisml-Tenantstring

Active tenant for the request (fallback for the axisml.tenant cookie).

Response

Job detail.

annotationsStringMap
createdAtstring date-time required

Time the job was created.

descriptionstring

Free-text job description.

displayNamestring

Human-readable job label.

idstring uuid required

Stable job identifier.

labelsStringMap
namestring required

Job definition name (unique within the tenant).

namespacestring required

Platform tenant namespace the job belongs to.

ownerstring required

Username of the job owner.

ownerIdstring uuid

User ID of the job owner.

tenantNamestring required

Tenant identifier owning the job.

updatedAtstring date-time required

Time the job was last updated.

Example response

{
  "annotations": {
    "axisml.io/created-by": "li.wei",
    "git-commit": "8c1f4e2"
  },
  "createdAt": "2026-06-20T08:00:00Z",
  "description": "Distributed ResNet-50 training job on ImageNet.",
  "displayName": "ResNet-50 Training",
  "id": "8c1f4e22-2b7a-4c0e-9b1d-7f3a2e5c9a10",
  "labels": {
    "team": "vision"
  },
  "name": "resnet-train",
  "namespace": "team-vision",
  "owner": "li.wei",
  "ownerId": "3a2b1c0d-4e5f-6789-abcd-ef0123456789",
  "runSummary": {
    "active": 1,
    "count": 7,
    "latestPhase": "Running",
    "latestRunAt": "2026-06-28T09:00:00Z",
    "recent": [
      "Succeeded",
      "Failed",
      "Succeeded",
      "Succeeded",
      "Running"
    ]
  },
  "spec": {
    "artifacts": [
      {
        "kind": "model",
        "name": "resnet50",
        "version": "1.4.0"
      }
    ],
    "backend": {
      "engine": "pytorchjob",
      "name": "native"
    },
    "configMaps": [
      {
        "data": {
          "trainer.yaml": "epochs: 90\nbatchSize: 256\n"
        },
        "name": "resnet-training-config"
      }
    ],
    "poolName": "gpu-a100",
    "roles": [
      {
        "name": "worker",
        "replicas": 4,
        "restartPolicy": "OnFailure",
        "template": {
          "args": [
            "--epochs",
            "90",
            "--batch-size",
            "256"
          ],
          "command": [
            "python",
            "train.py"
          ],
          "env": [
            {
              "name": "NCCL_DEBUG",
              "value": "INFO"
            }
          ],
          "envFrom": [
            {
              "configMapRef": {
                "name": "resnet-training-config"
              }
            }
          ],
          "image": "registry.axisml.io/training/resnet:1.4.0",
          "ports": [
            {
              "containerPort": 8080,
              "name": "http",
              "protocol": "TCP"
            }
          ],
          "resources": {
            "cpu": "8",
            "memory": "64Gi",
            "nvidia.com/gpu": "2"
          },
          "volumeMounts": [
            {
              "mountPath": "/data",
              "name": "data"
            },
            {
              "mountPath": "/etc/axisml",
              "name": "config",
              "readOnly": true
            }
          ],
          "volumes": [
            {
              "name": "data",
              "persistentVolumeClaim": {
                "claimName": "resnet-imagenet"
              }
            },
            {
              "configMap": {
                "name": "resnet-training-config"
              },
              "name": "config"
            }
          ]
        }
      }
    ],
    "runPolicy": {
      "activeDeadlineSeconds": 86400,
      "backoffLimit": 2,
      "progressDeadlineSeconds": 600,
      "ttlSecondsAfterFinished": 3600
    },
    "unitName": "a100-2x"
  },
  "tenantName": "team-vision",
  "updatedAt": "2026-06-28T09:30:00Z"
}

Changes

    • warning

      added the new Queued enum value to the ///////// response property for the response status

    • warning

      added the new Queued enum value to the ////// response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //////////// to the response with the status