Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a distributed job
Gets a distributed job.
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.
Gets a distributed job.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job - Scope
workflows:read - Effect
read— nothing is written. - Collection distributed_jobs
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the distributed job to get. Required. |
#Response
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#DistributedJobSpec
| Field | Type | What it is |
|---|---|---|
worker | JobSpec | The worker container: its image, command, env and instance type. timeout is the longest one worker lives, so the pool turns over; max_retries and concurrency do not apply. Required. |
worker_class | WorkerClass | Price and preemption class; default scavenger. One of scavenger, standard. |
scale | WorkerScale | Elastic bounds of the worker pool. |
scratch_gib | int32 | Local scratch disk at /scratch per worker, GiB; 0 is none. |
shard_count | int64 | A run that brings no shards of its own gets this many index-only shards. |
shard_timeout | duration | The longest one lease may live without the shard ending; default 30m. |
shard_retries | int32 | Attempts a shard gets after a failure; a preemption is not one. Default 3. |
max_failed_shards | int64 | Failed shards the run tolerates before it fails; default 0. |
run_timeout | duration | The whole run's deadline; default 48h. |
checkpoint_uri | string | data://<bucket>/<prefix>/: checkpoints go under <run>/<shard>/. |
output_uri | string | data://<bucket>/<prefix>/: outputs go under <run>/<shard>/. |
#DistributedJobStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
#JobSpec
| Field | Type | What it is |
|---|---|---|
service | string | The Hosting Service whose env and Secret bindings every run takes, and whose live Release image it runs unless image or build names another, so a Job never runs code the environment does not serve. Required. |
image | string | A digest-pinned image from this org's Artifacts, in place of the service's image. Exclusive with build. |
command | string[] | The entrypoint; empty keeps the image's. |
args | string[] | Arguments; a run may replace them. |
env | map<string, string> | Environment overrides on top of the service's env and Secret bindings. |
instance_type | string | A Hosting instance type; default standard. |
timeout | duration | One attempt's deadline, 10s to 24h; default 1h. |
max_retries | int32 | Re-runs after a non-zero exit, 0 to 10; backoff 30s doubling. |
concurrency | JobConcurrency | What a start does while a run is active; default forbid. One of forbid, queue, allow. |
build | string | A build the project declares: its latest built image, in place of the service's; the image needs no running service of its own. Exclusive with image. |
#WorkerScale
| Field | Type | What it is |
|---|---|---|
min_workers | int32 | Workers kept while shards remain; default 1. |
max_workers | int32 | The most workers at once; the Cell and the org quota cap it too. Default 1. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job" \
-H "Authorization: Bearer $SYLPHX_API_KEY"