RunPolarClawCronJob

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 run.	0ee00f56-f467-4d41-858c-ca4ede2c770e
Mode	string	No	The execution mode. Valid values: force and due. Default value: force.	force
Restart	boolean	No	Specifies whether to restart the gateway after the job completes. Default value: true.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	C61892A4-0850-4516-9E26-44D96C1782DE
Message	string	The response message.	successful
Code	integer	The status code.	200
ApplicationId	string	The application ID.	pa-**************
Ok	boolean	Indicates whether the operation was successful.	true
JobId	string	The unique ID for this job execution.	8006e51c-dab3-4602-bc69-4f728002c6ce
Ran	boolean	Indicates whether the job actually ran.	true

Examples

Success response

JSON format

{
  "RequestId": "C61892A4-0850-4516-9E26-44D96C1782DE",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "Ok": true,
  "JobId": "8006e51c-dab3-4602-bc69-4f728002c6ce",
  "Ran": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.