Distributed jobs
A DistributedJob runs one container image on many workers at once.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
A DistributedJob runs one container image on many workers at once. A run splits its work into shards that workers lease from a queue; the worker pool grows and shrinks with the capacity Kueue admits, and a preempted shard goes back to the queue.
Service Sylphx Workflows · Resource type workflows.sylphx.com/DistributedJob · Name pattern orgs/{org}/projects/{project}/envs/{env}/distributed_jobs/{distributed_job} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/distributed_jobs/{distributed_job}. |
uid | string | djob_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | DistributedJobSpec | Desired state. Required. |
status | DistributedJobStatus | Observed state. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a distributed job. |
GET | list | Lists distributed jobs. |
POST | create | Creates a distributed job. |
PATCH | update | Updates a distributed job. Runs already started keep the generation they pinned. |
DELETE | delete | Deletes a distributed job. |
get
Gets a distributed job.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job · scope workflows:read · effect read · Request, response and examples
list
Lists distributed jobs.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs · scope workflows:read · effect read · paginated · Request, response and examples
create
Creates a distributed job.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs · scope workflows:write · effect write · long-running · Request, response and examples
update
Updates a distributed job. Runs already started keep the generation they pinned.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job · scope workflows:write · effect write · long-running · Request, response and examples
delete
Deletes a distributed job.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job · scope workflows:write · effect destructive · long-running · Request, response and examples