# 查询任务列表
查询当前账号机构下的任务,返回一个任务列表(按照查询条件返回任务)。按照时间倒序排序给出
注意:
1、查询范围:只查当前账号所属机构下在任务列上的所有数据数据,不查询在回收站上的数据。
# 请求地址和请求方式
HTTP请求地址 | 请求方式 |
---|---|
{service}/api/v1/tasks | GET |
# 请求参数
序号 | 参数 | 类型 | 是否必填 | 长度限制 | 描述 | 示例值 |
---|---|---|---|---|---|---|
1 | status | int | 否 | 1 | 任务状态: 1:进行中;2:暂停中;3:已完成。 不填写时,默认返回上述所有状态下任务 | 1 |
2 | limit | int | 否 | 3 | 用来控制分页的参数;默认20,最大100;必须为正整数,不能输入0。 Limit 为单次返回的最多条目数量,Offset 为偏移量。当相应结果是列表形式时,如果数量超过了 Limit 所限定的值,那么只返回 Limit 个值。 举例来说,参数 Offset=0&Limit=20 返回第 0到 19 项,Offset=20&Limit=20 返回第 20 到 39 项,Offset=40&Limit=20 返回第 40 到 59 项;以此类推。 | 20 |
3 | offset | int | 否 | 5 | offset为偏移量,和limit结合使用。不填写时,默认为0。 | 0 |
# 请求示例
{
{service}/api/v1/tasks?SecretId=AKIDz8krbs2J5yKBZQpn74WFkmLPx3eh2&Signature=fdae105fbdd459f3ada35b728dc345cfb6e54cb3c5c8e12824c31ba6850892ed5&Timestamp=1618235242820&status=3
}
# 返回结果(调用正确)
{
{
"code":0,
"message":"调用成功",
"taskCount":2,
"taskList"[
{
"taskId":12043,
"taskName":"标注任务1",
"status":3
},
{
"taskId":12390,
"taskName":"语音标注任务001",
"status":3
}
]
}
}
# 返回结果说明
序号 | 返回项目 | 返回类型 | 项目说明 |
---|---|---|---|
1 | taskId | int | 任务ID |
2 | taskCount | int | 返回的任务总数 |
3 | taskName | string[] | 任务名称 |
# 返回结果(返回错误)
{
"code":321,
"message":" status参数错误"
}
# 错误码说明
序号 | 错误码 | 错误提示信息 |
---|---|---|
1 | 321 | status参数错误 |
2 | 322 | status类型错误 |
3 | 323 | limit参数类型错误 |
4 | 324 | limit参数必须小于100 |
5 | 325 | limit参数必须大于0 |
6 | 326 | offset参数类型错误 |
7 | 327 | 填写时,offset参数必须大于或者等于0 |