创建定时任务

接口说明


该接口用于创建实例的定时任务,支持的实例类型有开机,关机,重启,规格变更。

使用须知:

  1. 规格变更定时任务会涉及资源计费,会在定时任务开始执行时产生计费,建议您提前了解云服务器 ECS 的计费方式。

  2. 请妥善保管AccessKey,以防通过接口产生不知情订购资费。

注意事项:

  1. 冻结,退订,加入回收站的实例不允许加入定时任务。

  2. 同一个实例在5分钟内只允许一个定时任务在执行。

  3. 定时任务开始执行时间需晚于当前时间30分钟。

  4. 规格变更定时任务仅支持云主机实例,边缘云实例,且仅支持政企客户。

  5. 在创建实例定时任务时,当前实例状态需要处于运行中、已关机等终态。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-instance/v4/task/create

请求参数

Body

参数名称
类型
必填
描述
instanceActionTaskCreateReq
InstanceActionTaskCreateReq
是

instanceActionTaskCreateReq

taskName
string
否

任务名称,限制长度5-50个字符。若不填写,默认随机生成一个名称。

taskType
string
是

任务类型。取值范围:

  • START: 开机。
  • STOP: 关机。
  • REBOOT: 重启。
  • MODIFY_FLAVOR: 规格变更。
instanceActionTaskOperation
InstanceActionTaskOperation
否

任务执行策略所需参数。

hardAction
boolean
否

是否强制执行,该参数仅在taskType为START,STOP,REBOOT时生效。取值范围:

  • true: 强制执行。
  • false: 非强制执行。

默认值: false。

flavorName
string
否

规格名称,该参数仅在taskType为MODIFY_FLAVOR时必填。可通过查询实例可用规格列表获取。例如:c5.large.2。

taskStrategy
string
是

任务执行策略。取值范围:

  • SINGLE: 单次执行。
  • CYCLE: 周期执行。
taskCycleSelectedDays
<string> array
否

任务执行周期,该参数仅在taskStrategy为CYCLE时生效。取值范围:

  • SUN: 周日。
  • MON: 周一。
  • TUE: 周二。
  • WED: 周三。
  • THU: 周四。
  • FRI: 周五。
  • SAT: 周六。
taskExecTime
string
是

任务执行时间。该值类型依据taskStrategy:

  • 若taskStrategy取值CYCLE,则该参数取值类型为HH:mm:ss,例如09:52:12。
  • 若taskStrategy取值为SINGLE,则该参数取值类型为yyyy-MM-dd HH:mm:ss,例如2025-09-15 09:52:12。
taskExecEndTime
string
否

任务执行结束时间,则该参数仅在taskStrategy为CYCLE时生效。取值类型为yyyy-MM-dd HH:mm:ss,例如2025-09-15 10:52:12。

instanceIds
<string> array
是

实例ID数组,可通过查询实例状态列表接口获取。

请求示例

POST https://ecloud.10086.cn/api/openapi-instance/v4/task/create
{
	"taskType":"START",
	"taskStrategy":"CYCLE",
	"taskExecTime":"15:57:14",
	"taskCycleSelectedDays":[
		"MON",
		"TUE",
		"WED",
		"THU",
		"FRI",
		"SAT",
		"SUN"
	],
	"taskExecEndTime":"2025-09-26 13:50:10",
	"instanceIds":[
		"50b6a3cf-d5bd-414b-9a4b-bc88ab8d9fd7"
	]
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
InstanceActionTaskCreateResp

请求成功时返回的数据。

taskId
string

任务ID。

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"requestId":"reqId-f8c12f2e02d94ae2977276f248e60d39",
	"state":"OK",
	"body":{
		"taskId":"dda1289683b84d25bacd8cf38b62bbdf"
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。