停止部署任务
功能介绍
根据部署任务ID和执行记录ID停止部署任务。
调用方法
请参见如何调用API。
URI
PUT /v2/tasks/{task_id}/records/{record_id}/stop
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释： 部署任务ID。通过调用获取应用详情接口获取（响应体result.arrange_infos[0].id的值）。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
|
record_id |
是 |
String |
参数解释： 部署记录ID。通过调用根据开始时间和结束时间查询项目下指定应用的历史部署记录列表接口获取（响应体result[0].execution_id的值）。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 字符串，长度不超过20000个字符。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
StopDeployTaskRecordV2RequestBody |
是 |
Object |
参数解释： 停止部署任务执行请求体，兼容WSF请求体不能为空的要求, 传空JSON对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
CancelInfo object |
参数解释： 停止任务操作的任务信息。 取值范围： 不涉及。 |
|
status |
String |
参数解释： 停止任务执行结果。 取值范围：
|
请求示例
https://{endpoint}/v2/tasks/e700f15965694253940502911220d76b/records/2c82ffe8d00d4968a4e5f7a36d87ae17/stop
{ }
响应示例
状态码：200
OK，表示停止任务执行成功。
{
"status" : "success",
"result" : {
"id" : "2c82ffe8d00d4968a4e5f7a36d87ae17",
"task_id" : "e700f15965694253940502911220d76b"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK，表示停止任务执行成功。 |
错误码
请参见错误码。
