切换主题
查询任务列表
GEThttps://dashboard.avavox.com/open/api/task/list
请求头
Authorization string 必填
- 填写格式:
Authorization: Bearer <App Key> <App Key>为控制台「App Key 管理」页面生成的 Key。- 获取方式详见:《App Key 创建与管理》。
响应数据
code int
状态码,200 为成功,其他状态均为失败。
success boolean
是否成功,true 表示成功,false 表示失败。
message string
描述信息
data array
任务列表数据,结构如下:
点击展开字段说明
taskId string
任务 ID。
taskName string
任务名称
robotId string
任务使用的机器人 ID
robotName string
机器人名称
status object
任务状态
点击展开字段说明
status string
任务状态,取值如下:
pending: 未开始running:进行中paused:暂停中completed:已完成
pauseReason string
任务暂停的原因
请求示例
shell
curl --location 'https://dashboard.avavox.com/open/api/task/list' \
--header 'Authorization: Bearer $Key' \
--header 'Content-Type: application/json'响应示例
json
{
"code": 200,
"message": "操作成功",
"success": true,
"data": [
{
"taskId": "adfase",
"taskName": "任务1",
"robotId": "fwegw",
"robotName": "机器人1",
"status": {
"status": "completed",
"pauseReason": null
}
}
]
}