取消或强制停止作业调度
功能介绍
取消或强制作业调度。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/terminate
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
eihealth_project_id |
是 |
String |
参数解释: 平台空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
job_id |
是 |
String |
参数解释: 作业ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
force |
是 |
Boolean |
参数解释: 是否强制终止。 约束限制: 不涉及 取值范围:
默认取值: false |
响应参数
状态码:200
OK
无
请求示例
终止作业,启用强制终止模式,即运行中的步骤也会被终止。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/terminate { "force" : true }
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。