Task-状态列表
接口信息
- 接口地址:
{your-site-url}/api/skill/task/task-status - 基础 URL:
{your-site-url}需替换为你自己的独立站 URL 地址,如https://your-domain.com/apimanager666 - 请求方式:
GET - 说明: 此接口用于获取 Task(计划任务)的所有执行状态列表,返回各状态的多语言文本和对应
code值。
认证
请求头中需要携带 skill-access-token:
| Header | 值 |
|---|---|
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数
无参数。
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/task/task-status' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": [
{
"code": 1,
"text": "初始状态",
"cn": "初始状态",
"tw": "初始狀態",
"en": "init"
},
{
"code": 2,
"text": "处理中",
"cn": "处理中",
"tw": "處理中",
"en": "Processing"
},
{
"code": 3,
"text": "完成状态",
"cn": "完成状态",
"tw": "完成狀態",
"en": "Completed"
},
{
"code": 4,
"text": "task处理错误",
"cn": "task处理错误",
"tw": "task處理錯誤",
"en": "Task error"
},
{
"code": 5,
"text": "手动终止",
"cn": "手动终止",
"tw": "手動終止",
"en": "Manual Termination"
}
],
"message": "success"
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
code |
Number | 状态码,200 表示成功 |
message |
String | 执行结果的文字描述 |
data |
Array[Object] | Task 状态列表 |
data 子项字段
| 字段 | 类型 | 说明 |
|---|---|---|
code |
int | 状态值。1 = 初始状态,2 = 处理中,3 = 完成,4 = 处理错误,5 = 手动终止 |
text |
string | 默认文本 |
cn |
string | 中文名称 |
tw |
string | 繁体中文名称 |
en |
string | 英文名称 |
注意事项
- 主要用于 Task 列表页面按状态筛选时的下拉框数据源
code为用于筛选查询的值,如筛选处理中的 task 则传code=2