You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
任务管理
创建定时任务配置 CreateScheduledAgentRunTask
复制全文
下载 pdf
创建定时任务配置 CreateScheduledAgentRunTask
创建定时任务,系统将按照您设定的时间规律自动触发任务执行。​
使用说明​
调用 MUA OpenAPI 前,必须先访问 跨服务访问请求 为您的账号授权。​
注意事项​
  • 一个账号下,最多支持创建 50 个定时任务。​
  • 若上一次触发的任务还未结束,本次会自动跳过,避免重复运行。​
  • 若同一个设备上的多个定时任务在同一时间点触发,MUA 只会执行最新创建或更新的定时任务。​
  • 本接口整体 QPS 限制为 50 次/秒、单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://open.volcengineapi.com?Action=CreateScheduledAgentRunTask&Version=2023-08-01​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见 公共参数。​
Header​
​
参数​
类型​
是否必选​
示例值​
描述​
Content-Type​
String​
是​
application/json​
请求头信息。​
​
Query​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
CreateScheduledAgentRunTask​
接口名称。当前 API 的名称为 CreateScheduledAgentRunTask。​
Version​
String​
是​
2023-08-01​
接口版本。当前 API 的版本为 2023-08-01。​
​
Body​
​
参数​
类型​
是否必选​
示例值​
描述​
CronExpr​
String​
是​
0 10 * * * ​
定时规则表达式,用于设置任务自动执行的时间。采用标准 5 段式 crontab 格式,依次为“分钟 小时 日 月 星期”,例如 0 10 * * * 表示每天上午 10:00 触发一次。两次触发的时间间隔不能少于 10 分钟。​
Name​
String​
否​
every-10min-smoke​
定时任务名称,长度为 1~128 个字符,不传时默认使用任务的 RunName 作为名称。​
Status​
Integer​
否​
1​
定时任务状态,取值:​
  • 1:(默认值)启用定时任务。​
  • 2:停用定时任务。​
RunTaskOneStep​
Object​
否​
{}​
TaskType 为 run_one_step 时必填,字段与 一键运行代理任务 RunAgentTaskOneStep 一致。​
注意​
RunTaskOneStep 与 RunTask 默认只能二选一传入。​
RunTask​
Object​
否​
{}​
TaskType 为 run 时必填,字段与 运行代理任务 RunAgentTask 一致。​
注意​
RunTaskOneStep 与 RunTask 默认只能二选一传入。​
TaskType​
String​
否​
run_one_step​
任务创建方式,若不传该参数,系统将根据实际传入的 RunTaskOneStep 或 RunTask 参数,自动判断任务创建方式。取值:​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请参见 返回结构。​
​
参数​
类型​
示例值​
描述​
Id​
Integer​
176***​
定时任务配置 ID。​
NextFireAt​
Integer​
1785742200​
定时任务的下一次触发时间,以 Unix 时间戳格式表示。​
​
请求示例​
​
POST https://open.volcengineapi.com?Action=CreateScheduledAgentRunTask&Version=2023-08-01​
{​
"Name": "every-10min-smoke",​
"CronExpr": "0 10 * * *",​
"TaskType": "run_one_step",​
"Status": 1,​
"RunTaskOneStep": {​
"RunName": "scheduled-smoke",​
"ProductId": "prod-1",​
"PodId": "pod-1",​
"UserPrompt": "打开目标应用并完成巡检",​
"MaxStep": 100,​
"Timeout": 300​
}​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "CreateScheduledAgentRunTask",​
"Version": "2023-08-01",​
"Service": "ipaas",​
"Region": "cn-north-1"​
},​
"Result": {​
"Id": 176***,​
"NextFireAt": 1785742200​
}​
}​
​
错误码​
MUA OpenAPI 错误码请参见 错误码。​
最近更新时间:2026.09.30 16:45:08
这个页面对您有帮助吗?
有用
有用
无用
无用