启用ScheduledTask
功能介绍
根据ID启动定时运维任务。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/schedule/task/{task_id}/enable
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_id |
是 |
String |
参数解释: 定时任务ID。 约束限制: 真实存在的任意未启用的任务。 取值范围: 以“ST”开头长度26的字符串。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ticket_infos |
否 |
Array of TicketInfo objects |
参数解释: 变更管理相关配置信息,请参考变更管理进行配置。 约束限制: 若当前接口已在“变更管控”中启用了“工单授权”,则该值必填,即给定对应的提权信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ticket_id |
否 |
String |
参数解释: 变更管理相关工单ID。 约束限制: 请选择当前生效的工单。 取值范围: 不涉及。 默认取值: 不涉及。 |
ticket_type |
否 |
String |
参数解释: 工单类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
target_id |
否 |
String |
参数解释: 工单关联的应用ID。 约束限制: 请选择工单真实关联的应用ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
scope_id |
否 |
String |
参数解释: 区域ID。 约束限制: 请选择工单真实关联的区域ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
String |
参数解释: 接口响应数据。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
根据ID启用定时运维任务。
POST https://{Endpoint}/v1/schedule/task/ST****/enable
响应示例
状态码:200
请求成功。
{ "data" : "ST****" }
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
服务器未能处理请求。 |
错误码
请参见错误码。