Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Events

Cedana API for events

Storage timeline and current residency of a CSX checkpoint

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Checkpoint ID

Responses
200

Storage timeline and residency

application/json
checkpoint_idstringRequired
truncatedbooleanRequired

More events exist than were returned; only the newest are included.

get/v1/checkpoints/{id}/storage
GET /v1/checkpoints/{id}/storage HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "checkpoint_id": "text",
  "events": [
    {
      "action": "text",
      "action_id": "text",
      "checkpoint_id": "text",
      "cluster_id": "text",
      "context": "text",
      "description": "text",
      "duration_ns": 1,
      "failure_reason": "text",
      "failure_stage": "text",
      "id": "text",
      "name": "text",
      "namespace": "text",
      "node_name": "text",
      "operation": "text",
      "pause_ns": 1,
      "physical_bytes": 1,
      "pod_ready_at_ms": null,
      "pod_scheduled_at_ms": null,
      "pod_uid": "text",
      "read": true,
      "restore_uuid": "text",
      "result": "text",
      "storage_tier": "text",
      "timestamp": "text",
      "type": "text",
      "workload_type": "text",
      "write_target": "text"
    }
  ],
  "residency": [
    {
      "bytes": 1,
      "node_name": "text",
      "since_ms": 1,
      "state": "text",
      "tier": "text"
    }
  ],
  "truncated": true,
  "write": null
}

Where every CSX checkpoint of a cluster lives, with per-node cache usage

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
cluster_idstringRequired

Cluster to summarize

Responses
200

Cluster CSX residency

application/json
nfs_bytesinteger · int64Required
nfs_checkpointsinteger · int32Required
get/v1/csx/residency
GET /v1/csx/residency?cluster_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "checkpoints": [
    {
      "bytes": 1,
      "checkpoint_id": "text",
      "first_seen_ms": 1,
      "last_event_ms": 1,
      "last_read": null,
      "name": "text",
      "namespace": "text",
      "reads": 1,
      "residency": [
        {
          "bytes": 1,
          "node_name": "text",
          "since_ms": 1,
          "state": "text",
          "tier": "text"
        }
      ],
      "write": null
    }
  ],
  "nfs_bytes": 1,
  "nfs_checkpoints": 1,
  "nodes": [
    {
      "disk_checkpoints": 1,
      "disk_limit_bytes": 1,
      "disk_used_bytes": 1,
      "memory_checkpoints": 1,
      "memory_limit_bytes": 1,
      "memory_used_bytes": 1,
      "node_name": "text",
      "started_ms": null,
      "version": "text",
      "write_buffer_bytes": 1,
      "writes_in_flight": 1
    }
  ]
}

Recent checkpoint and restore results, newest first (the UI notification feed)

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
timeinteger · int32Optional

Time window in seconds (default: 3600)

hrsinteger · nullableOptional

Time window in hours; takes precedence over time

operationstring · nullableOptional

Filter by operation: checkpoint, restore, storage (CSX tier movements) or all. Without one, storage rows are left out so they cannot crowd checkpoint and restore results.

cluster_idstring · nullableOptional

Filter by cluster

workloadstring · nullableOptional

Filter by workload: kubernetes or slurm

Responses
200

Recent operation results

application/json
get/v1/events
GET /v1/events HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "events": [
    {
      "action": "text",
      "action_id": "text",
      "checkpoint_id": "text",
      "cluster_id": "text",
      "context": "text",
      "description": "text",
      "duration_ns": 1,
      "failure_reason": "text",
      "failure_stage": "text",
      "id": "text",
      "name": "text",
      "namespace": "text",
      "node_name": "text",
      "operation": "text",
      "pause_ns": 1,
      "physical_bytes": 1,
      "pod_ready_at_ms": null,
      "pod_scheduled_at_ms": null,
      "pod_uid": "text",
      "read": true,
      "restore_uuid": "text",
      "result": "text",
      "storage_tier": "text",
      "timestamp": "text",
      "type": "text",
      "workload_type": "text",
      "write_target": "text"
    }
  ]
}
PreviousPolicy (Slurm)
NextMetrics

Last updated

Was this helpful?