用于启用PolarClaw中的定时任务功能。
接口说明
请求说明
本 API 用于在 PolarClaw 应用中启用一个定时任务(Cron Job)。通过调用此接口,可以为指定的应用程序设置或激活一个定时任务,以便按照预定的时间表执行特定的操作或流程。请确保在请求中提供正确的ApplicationId以关联到目标应用程序。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ApplicationId |
string |
是 |
应用 ID |
pa-************** |
| JobId |
string |
是 |
要启用的定时任务 ID |
0ee00f56-f467-4d41-858c-ca4ede2c770e |
| Restart |
boolean |
否 |
创建后是否重启网关,默认 true |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID |
2281C6C9-CBAB-1AFD-8400-670750CF6025_2212 |
| Message |
string |
返回消息 |
successful |
| Code |
integer |
返回状态码 |
200 |
| ApplicationId |
string |
应用 ID |
pa-************** |
| Ok |
boolean |
操作是否成功 |
true |
| JobId |
string |
启用的任务 ID |
8006e51c-dab3-4602-bc69-4f728002c6ce |
示例
正常返回示例
JSON格式
{
"RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Ok": true,
"JobId": "8006e51c-dab3-4602-bc69-4f728002c6ce"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。