FastSim
◎ 中文
← Server REST API  /  run
HTTPv1

Run lifecycle

Current Server Run lifecycle surface; paths, methods, status codes and handler signatures come directly from 0.8.4 source.

Source packages/fastsim-plugin-server/src/fastsim_plugin_server/application.py
run_inforun_artifactsrun_artifactlifecycle_closerun_launchlifecycle_pauselifecycle_preparelifecycle_resetlifecycle_resumerun_snapshotlifecycle_startlifecycle_steplifecycle_stop

Endpoints 13

GET/api/v1/runrun_info
200dict[str, object]

Run info

Handlerrun_info
Signatureasync run_info() -> JSONResponse
SourceL2259
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/run
GET/api/v1/run/artifactsrun_artifacts
200dict[str, object]

Run artifacts

Handlerrun_artifacts
Signatureasync run_artifacts(slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2299
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/run/artifacts
GET/api/v1/run/artifacts/{artifact_path:path}run_artifact
200dict[str, object]

Run artifact

Handlerrun_artifact
Signatureasync run_artifact(artifact_path: str=Path(min_length=1, max_length=4096), slot_generation: _SlotGenerationHeader=None, range_header: _RangeHeader=None) -> Response
SourceL2314
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/run/artifacts/{artifact_path:path}
POST/api/v1/run/closelifecycle_close
202dict[str, object]

Terminally close the owned Run while preserving operation history.

Handlerlifecycle_close
Signatureasync lifecycle_close(payload: _EmptyBody=None, idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2598
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/close \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/run/launchrun_launch
202dict[str, object]

Run launch

Handlerrun_launch
Signatureasync run_launch(payload: RunLaunchRequest, idempotency_key: _RequiredIdempotencyHeader) -> JSONResponse
SourceL2517
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/launch \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/run/pauselifecycle_pause
202dict[str, object]

Lifecycle pause

Handlerlifecycle_pause
Signatureasync lifecycle_pause(payload: _EmptyBody=None, idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2548
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/pause \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/run/preparelifecycle_prepare
202dict[str, object]

Lifecycle prepare

Handlerlifecycle_prepare
Signatureasync lifecycle_prepare(payload: _EmptyBody=None, idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2530
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/prepare \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/run/resetlifecycle_reset
202dict[str, object]

Lifecycle reset

Handlerlifecycle_reset
Signatureasync lifecycle_reset(payload: _EmptyBody=None, idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2580
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/reset \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/run/resumelifecycle_resume
202dict[str, object]

Lifecycle resume

Handlerlifecycle_resume
Signatureasync lifecycle_resume(payload: _EmptyBody=None, idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2557
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/resume \
  -H 'Content-Type: application/json' \
  -d @request.json
GET/api/v1/run/snapshotrun_snapshot
200dict[str, object]

Run snapshot

Handlerrun_snapshot
Signatureasync run_snapshot() -> JSONResponse
SourceL2373
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/run/snapshot
POST/api/v1/run/startlifecycle_start
202dict[str, object]

Lifecycle start

Handlerlifecycle_start
Signatureasync lifecycle_start(payload: _EmptyBody=None, idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2539
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/start \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/run/steplifecycle_step
202dict[str, object]

Lifecycle step

Handlerlifecycle_step
Signatureasync lifecycle_step(payload: _StepBody=None, idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2566
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/step \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/run/stoplifecycle_stop
202dict[str, object]

Lifecycle stop

Handlerlifecycle_stop
Signatureasync lifecycle_stop(payload: _EmptyBody=None, idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL2589
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/run/stop \
  -H 'Content-Type: application/json' \
  -d @request.json