停止任务
功能介绍
根据任务ID停止任务
URI
POST /v1/{project_id}/sbc/task/stop
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户project_id 最小长度:32 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
任务ID,创建任务时返回的ID 最小长度:36 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
|
Content-Type |
是 |
String |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
响应内容 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务ID,创建任务时返回的ID 最小长度:36 最大长度:36 |
result |
String |
停止是否成功,成功时返回success,失败时返回failure 最小长度:0 最大长度:10 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 429
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
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 |
错误响应体 |
错误码
请参见错误码。