列出异步任务 - ListCoreSpaceJobs
功能介绍
分页列出指定Space下的异步任务
调用方法
请参见如何调用API。
URI
GET /v1/core/spaces/{space_id}/jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| space_id | 是 | String | 参数解释: 记忆库 ID,唯一标识一个记忆库,可以通过AgentArts智能体记忆库控制台或者记忆库查询接口获取。 约束限制: 仅支持字母、数字和中划线。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页返回的记录数量(条),用于分页查询。 约束限制: 不涉及。 取值范围: 1-100。 默认取值: 20。 |
| offset | 否 | Integer | 参数解释: 偏移量(条),用于分页查询时指定起始位置,从0开始。 约束限制: 不涉及。 取值范围: 0-100000。 默认取值: 0。 |
| status | 否 | String | 参数解释: 按任务执行状态过滤异步任务。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| job_name | 否 | String | 参数解释: 按任务名称过滤(模糊匹配)。 约束限制: 长度不超过128个字符,支持[待补充]字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| jobs | Array of CoreSpaceJobSummary objects | 参数解释: 异步任务列表。 取值范围: 不涉及。 |
| size | Integer | 参数解释: 当前页返回的任务数量(条)。 取值范围: 不涉及。 |
| total | Integer | 参数解释: 任务总数(条)。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 异步任务 ID,唯一标识一个异步任务,可通过创建异步任务的接口返回获取。 取值范围: 不涉及。 |
| job_name | String | 参数解释: 异步任务名称,标识任务的类型。 取值范围: |
| status | String | 参数解释: 异步任务的当前执行状态。 取值范围: |
| created_at | String | 参数解释: 记录的创建时间,由系统自动生成,格式为 ISO 8601(YYYY-MM-DDTHH:mm:ssZ)。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 记录的最近更新时间,由系统自动更新,格式为 ISO 8601(YYYY-MM-DDTHH:mm:ssZ)。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权失败信息。 取值范围: 不涉及。 |
| details | Array of CoreSpaceCommonError objects | 参数解释: 依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
请求示例
/v1/core/spaces/123e4567-e89b-12d3-a456-426614174000/jobs?limit=20&offset=0
响应示例
状态码:200
成功获取任务列表
{
"jobs" : [ {
"id" : "123e4567-e89b-12d3-a456-426614174000",
"job_name" : "update_network",
"status" : "running",
"created_at" : "2025-01-18T10:00:00.000Z",
"updated_at" : "2025-01-18T10:00:00.000Z"
}, {
"id" : "123e4567-e89b-12d3-a456-426614174001",
"job_name" : "create_space",
"status" : "running",
"created_at" : "2025-01-18T10:00:00.000Z",
"updated_at" : "2025-01-18T10:00:00.000Z"
} ],
"size" : 2,
"total" : 90
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功获取任务列表 |
| 400 | 请求参数错误。 |
| 401 | 认证失败。 |
| 403 | 权限不足。 |
| 404 | 记忆库未找到 |
| 429 | 请求频率超限。 |
| 500 | 内部服务器错误 |
错误码
请参见错误码。