更新时间:2025-08-13 GMT+08:00
分享

停止任务

功能介绍

根据任务ID停止任务

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/sbc/task/stop

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户项目ID,获取方式请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

id

String

任务ID,创建任务时返回的ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

认证Token

Content-Type

String

请求类型

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

data object

响应内容

表5 data

参数

参数类型

描述

id

String

任务ID,创建任务时返回的ID

result

String

停止是否成功,成功时返回success,失败时返回failure

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:429

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v1/{project_id}/sbc/task/stop?id={id}

响应示例

状态码:200

停止任务响应对象

{
  "data" : {
    "id" : "00000000-0000-0000-0000-000000000000",
    "result" : "success"
  }
}

状态码

状态码

描述

200

停止任务响应对象

400

错误响应体

401

错误响应体

429

错误响应体

错误码

请参见错误码

相关文档