メインコンテンツへスキップ
Work API は self_hosted Environment に接続された外部 worker によって使用されます。worker はキューに入った Session work をポーリングし、実行するアイテムを確認応答し、heartbeat でリースを維持し、work が完了または中断すべき時にアイテムを停止します。

Work item オブジェクト

list、poll、get、update metadata、acknowledge、stop の各エンドポイントによって返されます。
フィールド説明
idstringwork_ プレフィックス付きの Work item ID
typestring常に "work"
environment_idstringenv_ プレフィックス付きの Environment ID
dataobjectwork ペイロードの記述子
data.typestring現在は常に "session"
data.idstringsess_ プレフィックス付きの Session ID
statestringWork item の状態。Work の状態 を参照
created_atstringUTC での作成時刻
acknowledged_atstring|nullworker がアイテムを確認応答した時刻、ack 前は null
started_atstring|null最初の heartbeat でアイテムが active へ移行した時刻、開始前は null
latest_heartbeat_atstring|null最新の heartbeat タイムスタンプ、最初の heartbeat 前は null
stop_requested_atstring|nullグレースフル停止がリクエストされた時刻、または null
stopped_atstring|nullアイテムが stopped に到達した時刻、稼働中は null
metadataobjectwork item に関連付けられた文字列のみのメタデータ

Work の状態

状態説明
queuedwork item がポーリング可能である、または配信されたがまだ確認応答されていない
startingworker がアイテムを確認応答し、実行を開始すべきである
activeworker が heartbeat を送信し、現在のリースを所有している
stoppingグレースフル停止がリクエストされた。worker はドレインして停止を確定すべきである
stoppedアイテムは稼働しておらず、heartbeat できない

Work メタデータ

Work メタデータは文字列のみのマップです。Session が work item を作成すると、Session のメタデータがこの文字列マップに投影されます。変更をマージするには Work item メタデータの更新 を使用します:
  • 文字列値はキーを upsert します。
  • null はキーを削除します。
  • metadata を省略すると、現在のメタデータは変更されません。

Work heartbeat オブジェクト

Work heartbeat の送信 によって返されます。
フィールド説明
typestring常に "work_heartbeat"
last_heartbeatstring受理された heartbeat のサーバータイムスタンプ
lease_extendedboolean成功した heartbeat では常に true
statestringheartbeat 後の現在の work item 状態
ttl_secondsinteger現在のリース TTL(秒)

Work キュー統計オブジェクト

Work キュー統計の取得 によって返されます。
フィールド説明
typestring常に "work_queue_stats"
depthinteger現在 worker が取得可能なキュー内アイテム
pendinginteger直近に配信されたがまだ確認応答されていないキュー内アイテム
oldest_queued_atstring|null最も古いキュー内アイテムの作成時刻、キューが空の場合は null
workers_pollinginteger直近 30 秒間にこの environment をポーリングした一意の Worker-ID

関連

クラウド環境

Agent が実行されるコンテナ、ネットワーク、依存関係を選択する。