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
Read shards on a distributed run
Reads a page of the run's shards, in queue order.
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.
Reads a page of the run's shards, in queue order.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/distributed_jobs/distributed-job/distributed_runs/distributed-run:readShards - Scope
workflows:read - Effect
read— nothing is written. - Collection distributed_runs
- Query
page_size,page_token,state_filter
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the distributed run. Required. |
page_size | int32 | At most this many; default 100, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
state_filter | ShardState | Only shards in this state; unset reads every shard. One of pending, leased, succeeded, failed. |
#Response
| Field | Type | What it is |
|---|---|---|
shards | Shard[] | The page, in queue order. |
next_page_token | string | The token of the next page; empty on the last page. |
#Shard
| Field | Type | What it is |
|---|---|---|
id | string | The shard id, unique in its run. Output only. |
seq | int64 | Order in the run's queue, from 0. Output only. |
state | ShardState | The shard's state. Output only. One of pending, leased, succeeded, failed. |
attempts | int32 | Attempts counted so far (failures and timeouts, not preemptions). Output only. |
worker | string | The worker holding or last holding the lease. Output only. |
outputs | value | What the worker reported at complete, any JSON. Output only. |
error | string | The last failure's message. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.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/distributed_runs/distributed-run:readShards" \
-H "Authorization: Bearer $SYLPHX_API_KEY"