GET 任务列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/task |
| 所属业务 | 系统管理 |
| 来源模块/系统 | 任务管理 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
任务列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| keywords | query | string | 否 | 关键字 搜索范围:任务ID 描述 |
| status | query | string | 否 | 状态 Wait未开始 Exec执行中 Finish完成 Failed失败 |
| start_time | query | integer(int32) | 否 | 开始时间 |
| end_time | query | integer(int32) | 否 | 结束时间 |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
| orderby | query | string | 否 | 排序 id description status start_time finish_time |
| sort | query | string | 否 | 升/降序 asc desc |
| type | query | string | 否 | 任务类型 addon_client_care客户通知 addon_renew_batch_renew批量续费 batch_host_sync批量同步产品 email邮件通知 email_notice_admin邮件通知管理员 host_create开通 host_suspend暂停 host_terminate删除 host_upgrade升降级 idcsmart_webhook_notice webhook通知 mp_weixin_notice微信公众号通知 sms短信通知 |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.list | [object] | 否 | — | 任务列表 |
data.list[].id | integer(int32) | 否 | — | 任务ID |
data.list[].description | string | 否 | — | 描述 |
data.list[].status | string | 否 | — | 状态 Wait未开始 Exec执行中 Finish完成 Failed失败 |
data.list[].retry | string | integer(int32) | 否 | — | 是否已重试 0否 1是 |
data.list[].start_time | integer(int32) | 否 | — | 开始时间 |
data.list[].finish_time | integer(int32) | 否 | — | 完成时间 |
data.list[].fail_reason | string | 否 | — | 失败原因 |
data.count | integer(int32) | 否 | — | 任务总数 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |