接口说明
调用operate接口修改投递任务状态。修改状态操作不能与当前状态矛盾,如任务已经处于运行中,无法进行启动操作。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST/paasopenapi/api/cmplogadmin/cmplog/tenant/dataSend/operateHTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
taskId | String | Body | 是 | 10001 | 日志投递任务ID |
operateType | String | Body | 是 | 0 | 操作类型:0-停止;1-重启;2-删除;3-启动 |
message | String | Body | 否 | 投递任务停止 | 任务执行信息 |
返回数据
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 返回状态码 |
data | Object | 若修改状态操作成功,返回空值 | |
msg | String | "" | 返回信息 |
示例
请求示例
GET/paasopenapi/api/cmplogadmin/cmplog/tenant/dataSend/operateHTTP/1.1
{
"message":"投递任务停止","operateType":"0","taskId":"10001"}
正常返回示例
{
"code":0,
"data":{},
"msg":""
}
错误码
HTTP状态码(Status Code) | 错误码(Error Code) | 描述(Description) |
---|---|---|
400 | MissingParameter | 缺少必要的请求参数。 |
400 | InvalidParameterValue | 请求参数取值错误。 |
404 | TaskNotExist | 投递任务不存在 |
500 | FailedOperation | 操作失败 |