EnablePolarClawCronJob
Enables a cron job in PolarClaw.
Operation description
Request
This operation enables a cron job in a PolarClaw application to run tasks on a schedule. Specify the correct ApplicationId to associate the job with the target application.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ApplicationId |
string |
Yes |
The application ID. |
pa-************** |
| JobId |
string |
Yes |
The ID of the cron job to enable. |
0ee00f56-f467-4d41-858c-ca4ede2c770e |
| Restart |
boolean |
No |
Specifies whether to restart the gateway after the job is enabled. The default value is |
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response schema |
||
| RequestId |
string |
The request ID. |
2281C6C9-CBAB-1AFD-8400-670750CF6025_2212 |
| Message |
string |
The response message. |
successful |
| Code |
integer |
The response status code. |
200 |
| ApplicationId |
string |
The application ID. |
pa-************** |
| Ok |
boolean |
Indicates whether the operation was successful. |
true |
| JobId |
string |
The ID of the enabled job. |
8006e51c-dab3-4602-bc69-4f728002c6ce |
Examples
Success response
JSON format
{
"RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Ok": true,
"JobId": "8006e51c-dab3-4602-bc69-4f728002c6ce"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.