PolarClaw 内のすべての定期タスク、または特定の定期タスクとその詳細を照会します。
操作説明
リクエストの説明
この API を使用して、PolarClaw アプリケーション内のすべての定期タスクを取得するか、
JobIdListパラメーターを使用して特定のタスクをフィルターできます。JobIdListパラメーターを指定しない場合、API はアプリケーション内のすべての定期タスクを返します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ApplicationId |
string |
必須 |
アプリケーション ID |
pa-************** |
| JobIdList |
array |
任意 |
ジョブ ID リストによるフィルター |
0ee00f56-f467-4d41-858c-ca4ede2c770e,1ee00f56-f467-4d41-858c-ca4ede2c770f |
|
string |
任意 |
ジョブ ID |
0ee00f56-f467-4d41-858c-ca4ede2c770e |
|
| IncludeDisabled |
boolean |
任意 |
無効化されたタスクを含めるかどうか。デフォルトは true です。 |
true |
| IncludeRuns |
boolean |
任意 |
実行履歴を含めるかどうか。デフォルトは false です。 |
true |
| RunLimit |
integer |
任意 |
タスクごとの実行履歴の最大件数。デフォルトは 10 です。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答スキーマ |
||
| RequestId |
string |
リクエスト ID |
2281C6C9-CBAB-1AFD-8400-670750CF6025_2212 |
| Message |
string |
応答メッセージ |
successful |
| Code |
integer |
ステータスコード |
200 |
| ApplicationId |
string |
アプリケーション ID |
pa-************** |
| Jobs |
array<object> |
定期タスクのリスト |
|
|
array<object> |
定期タスク |
||
| Id |
string |
タスク ID (UUID) |
0ee00f56-f467-4d41-858c-ca4ede2c770e |
| Name |
string |
タスク名 |
test |
| Enabled |
boolean |
有効かどうか |
true |
| DeleteAfterRun |
boolean |
初回実行後に削除するかどうか |
false |
| CreatedAtMs |
integer |
作成タイムスタンプ (ミリ秒) |
1777370572517 |
| UpdatedAtMs |
integer |
更新タイムスタンプ (ミリ秒) |
1777368967284 |
| Schedule |
object |
スケジュール構成 |
|
| Kind |
string |
スケジュールタイプ：cron/every/at |
cron |
| Expr |
string |
Cron 式 |
0 9 * * * |
| Tz |
string |
IANA タイムゾーン |
Asia/Shanghai |
| EveryMs |
integer |
間隔 (ミリ秒) |
100000 |
| AnchorMs |
integer |
間隔のアラインメントアンカータイムスタンプ |
1777370572518 |
| At |
string |
ISO 8601 タイムスタンプ |
2026-04-10T09:00:00+08:00 |
| SessionTarget |
string |
セッションターゲット：main/isolated/current |
main |
| WakeMode |
string |
ウェイクモード：now/next-heartbeat |
now |
| Payload |
object |
実行ペイロード |
|
| Kind |
string |
ペイロードタイプ：agentTurn/systemEvent |
systemEvent |
| Message |
string |
エージェント会話プロンプト |
Generate the daily report. |
| Text |
string |
システムイベントテキスト |
Generate the daily report. |
| Model |
string |
モデルオーバーライド |
bailian/qwen3.5-plus |
| TimeoutSeconds |
integer |
実行タイムアウト (秒) |
10 |
| LightContext |
boolean |
軽量コンテキストを使用するかどうかを示します。 |
false |
| Deliver |
boolean |
出力をチャンネルに配信します。 |
true |
| Channel |
string |
配信チャネル ID |
feishu |
| To |
string |
配信先 |
ou_*** |
| BestEffortDeliver |
boolean |
配信失敗を無視するかどうか |
false |
| AgentId |
string |
実行エージェント ID |
main |
| SessionKey |
string |
セッションルーティングキー |
agent:main:feishu:direct:*** |
| Description |
string |
タスクの説明 |
Daily report generation |
| Delivery |
object |
結果配信構成 |
|
| Mode |
string |
配信モード：none/announce/webhook |
announce |
| Channel |
string |
配信チャネル |
feishu |
| AccountId |
string |
チャネルアカウント ID |
default |
| To |
string |
配信先 |
ou_*** |
| BestEffort |
boolean |
配信失敗を無視するかどうか |
false |
| State |
object |
実行ステータス |
|
| NextRunAtMs |
integer |
次回実行タイムスタンプ (ミリ秒) |
1777424400000 |
| LastRunAtMs |
integer |
前回実行タイムスタンプ (ミリ秒) |
1777370544931 |
| LastRunStatus |
string |
前回実行ステータス |
ok |
| ConsecutiveErrors |
integer |
連続失敗回数 |
0 |
| Runs |
array<object> |
実行履歴 |
|
|
array<object> |
実行履歴 |
||
| Ts |
integer |
実行タイムスタンプ (ミリ秒) |
1777370572518 |
| JobId |
string |
関連するタスク ID |
f83f5278-1abe-40a6-b10e-ad3ecdc05de2 |
| Action |
string |
アクション：finished/error/skipped |
finished |
| Status |
string |
ステータス：ok/error/skipped |
ok |
| Summary |
string |
実行サマリーテキスト |
Generate the daily report. |
| Delivered |
boolean |
ジョブが配信されたかどうかを示します。 |
false |
| DeliveryStatus |
string |
配信ステータス |
not-requested |
| SessionId |
string |
関連するセッション ID |
*** |
| RunAtMs |
integer |
実際の実行タイムスタンプ (ミリ秒) |
1777370544931 |
| DurationMs |
integer |
実行持続時間 (ミリ秒) |
27586 |
| NextRunAtMs |
integer |
次回実行タイムスタンプ (ミリ秒) |
1777424400000 |
| Model |
string |
使用されたモデル |
bailian/qwen3.5-plus |
| Provider |
string |
モデルプロバイダー |
bailian |
| Usage |
object |
トークン使用量の詳細 |
|
| InputTokens |
integer |
入力トークン数 |
30250 |
| OutputTokens |
integer |
出力トークン数 |
30250 |
| TotalTokens |
integer |
トークン総数 |
60500 |
| JobName |
string |
タスク名 |
test |
| Total |
integer |
タスクの総数 |
1 |
例
成功レスポンス
JSONJSON
{
"RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Jobs": [
{
"Id": "0ee00f56-f467-4d41-858c-ca4ede2c770e",
"Name": "test",
"Enabled": true,
"DeleteAfterRun": false,
"CreatedAtMs": 1777370572517,
"UpdatedAtMs": 1777368967284,
"Schedule": {
"Kind": "cron",
"Expr": "0 9 * * *",
"Tz": "Asia/Shanghai",
"EveryMs": 100000,
"AnchorMs": 1777370572518,
"At": "2026-04-10T09:00:00+08:00"
},
"SessionTarget": "main",
"WakeMode": "now",
"Payload": {
"Kind": "systemEvent",
"Message": "Generate the daily report.",
"Text": "Generate the daily report.",
"Model": "bailian/qwen3.5-plus",
"TimeoutSeconds": 10,
"LightContext": false,
"Deliver": true,
"Channel": "feishu",
"To": "ou_***",
"BestEffortDeliver": false
},
"AgentId": "main",
"SessionKey": "agent:main:feishu:direct:***",
"Description": "Daily report generation",
"Delivery": {
"Mode": "announce",
"Channel": "feishu",
"AccountId": "default",
"To": "ou_***",
"BestEffort": false
},
"State": {
"NextRunAtMs": 1777424400000,
"LastRunAtMs": 1777370544931,
"LastRunStatus": "ok",
"ConsecutiveErrors": 0
},
"Runs": [
{
"Ts": 1777370572518,
"JobId": "f83f5278-1abe-40a6-b10e-ad3ecdc05de2",
"Action": "finished",
"Status": "ok",
"Summary": "Generate the daily report.",
"Delivered": false,
"DeliveryStatus": "not-requested",
"SessionId": "***",
"RunAtMs": 1777370544931,
"DurationMs": 27586,
"NextRunAtMs": 1777424400000,
"Model": "bailian/qwen3.5-plus",
"Provider": "bailian",
"Usage": {
"InputTokens": 30250,
"OutputTokens": 30250,
"TotalTokens": 60500
},
"JobName": "test"
}
]
}
],
"Total": 1
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。