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
Add shards on a distributed run
Appends shards to a run started with an open manifest; `close` ends the manifest, and the run ends once those shards are done.
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.
Appends shards to a run started with an open manifest; close ends the manifest, and the run ends once those shards are done.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job/distributed_runs/distributed-run:addShards - Scope
workflows:run - Effect
write— a successful call changes state. - Collection distributed_runs
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the distributed run; its manifest must be open. Required. |
shards | ShardInput[] | The shards to append. |
close | bool | Close the manifest: the run ends once its shards are done. |
#ShardInput
| Field | Type | What it is |
|---|---|---|
id | string | The shard id, unique in the run; the server assigns one when empty. |
input | value | What the worker gets as its input, any JSON. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/distributed_jobs/{distributed_job}/distributed_runs/{distributed_run}. |
uid | string | drun_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
job_generation | int64 | The DistributedJob generation the run pinned. Output only. |
state | DistributedRunState | The run's lifecycle state. Output only. One of queued, running, draining, succeeded, failed, cancelled, timed_out. |
manifest_open | bool | Whether more shards may still be added (:addShards). Output only. |
message | string | Why the run failed or was refused, when it did. Output only. |
create_time | timestamp | When the run was accepted. Output only. |
start_time | timestamp | When the first worker started. Output only. |
end_time | timestamp | When the run closed. Output only. |
shard_counts | ShardCounts | Shards by state. Output only. |
worker_counts | WorkerCounts | Workers by state. Output only. |
usage | DistributedRunUsage | Metered usage across workers. Output only. |
args | string[] | Arguments of every worker of this run (the job's when empty). |
env | map<string, string> | Environment overrides of this run. |
shards | ShardInput[] | The run's own shards (the customer's planner output); without them the job's shard_count makes index-only shards. |
open_manifest | bool | Keep the manifest open: :addShards appends until it is closed. |
#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. |
#ShardCounts
| Field | Type | What it is |
|---|---|---|
pending | int64 | Waiting to be leased. Output only. |
leased | int64 | Held by a worker. Output only. |
succeeded | int64 | Completed. Output only. |
failed | int64 | Out of attempts. Output only. |
total | int64 | Every shard of the run. Output only. |
#WorkerCounts
| Field | Type | What it is |
|---|---|---|
created | int64 | Every worker the run created. Output only. |
waiting | int64 | Waiting for Kueue to admit them. Output only. |
running | int64 | Running. Output only. |
ended | int64 | Ended. Output only. |
#DistributedRunUsage
| Field | Type | What it is |
|---|---|---|
worker_duration | duration | Summed worker run time from container start to exit. Output only. |
worker_class | WorkerClass | The price class the workers ran in. Output only. One of scavenger, standard. |
instance_type | string | The instance type the workers ran on. Output only. |
#ShardInput
| Field | Type | What it is |
|---|---|---|
id | string | The shard id, unique in the run; the server assigns one when empty. |
input | value | What the worker gets as its input, any JSON. |
#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.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job/distributed_runs/distributed-run:addShards" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'