查询定时任务配置
功能介绍
查询定时任务配置。
调用方法
请参见如何调用API。
URI
GET /v1/tasks/{task_id}/taskcron
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_id |
是 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
operator |
否 |
String |
参数解释: 操作人,填写用户名 约束限制: 不涉及 约束限制: 字符串长度不少于1,不超过128。 默认取值: 不涉及 |
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 响应状态。 取值范围: success:成功。 failed:失败。 |
httpStatus |
Integer |
参数解释: 响应状态码。 取值范围: ok:成功。 failed:失败。 |
result |
TaskCronResult object |
参数解释: 定时任务配置。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
taskId |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
cronStatus |
String |
参数解释: 定时任务状态。 取值范围: 0: 关闭。1: 开启。 |
weekDays |
Array of strings |
参数解释: 定时任务在哪几天执行。 取值范围: 0-6分别代表星期日到星期六。 |
detailTime |
String |
参数解释: 定时任务执行的时间。 取值范围: 24小时制时间。 |
creator |
String |
参数解释: 定时任务的创建者。 取值范围: 不涉及。 |
timeOffset |
String |
参数解释: GMT格式时间偏移量。 取值范围: GMT格式时间偏移量。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
查询定时任务配置
GET https://{endpoint}/v1/tasks/fxxxx7ba3ae14a87a32b151bcbe20801/taskcron
响应示例
状态码:200
Request succeeded!
{ "status" : "success", "httpStatus" : "OK", "result" : { "taskId" : "fxxxx7ba3ae14a87a32b151bcbe20801", "cronStatus" : "0", "weekDays" : [ "0", "1", "2" ], "detailTime" : "15:00", "creator" : "creator", "timeOffset" : "GMT+08:00" } }
状态码:400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "网络繁忙,请稍后再试" }
状态码:401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
200 |
Request succeeded! |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。