接口功能介绍
获取异步任务列表
接口约束
无
URI
GET /openapi/v1/functions/*/async-tasks
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| functionName | 是 | String | 函数名称 | test |
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prefix | 是 | String | 异步任务 ID 前缀，指定后会返回符合前缀的异步任务列表。 | job- | |
| qualifier | 是 | String | 函数版本或别名。 | LATEST | |
| status | 是 | String | 异步任务执行状态。 Enqueued：异步消息已入队，等待处理。 Succeeded：调用执行成功。 Failed：调用执行失败。 Running：调用执行中。 Stopped：调用执行终止。 Stopping：执行停止中。 Invalid：执行因函数被删除等原因处于无效状态（任务未被执行）。 Expired：为任务配置了最长排队等待的期限。该任务因为超期被丢弃（任务未被执行）。 Retrying：异步调用因执行错误重试中。 |
Running | |
| startedTimeBegin | 是 | Integer | 异步任务启动时间段的开始时间，单位毫秒 | 1640966400000 | |
| startedTimeEnd | 是 | Integer | 异步任务启动时间段的结束时间，单位毫秒 | 1640966400000 | |
| pageIndex | 是 | Integer | 页码 | 1 | |
| pageSize | 是 | Integer | 页大小，取值范围[1,100] | 10 | |
| orderByTime | 是 | String | 返回异步任务列表的排序方式，默认降序 asc 表示升序 desc 表示降序 |
desc |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | test |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码,0表示成功，非0表示不成功 | 0 | |
| error | String | 错误码 | CF_0 | |
| message | String | 信息 | ||
| returnObj | Object | 返回实体 | ReturnObj |
表 ReturnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Array of Objects | 分页数据 | Data | |
| pagination | Object | 分页信息 | Pagination |
表 Pagination
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageIndex | Integer | 页码 | ||
| pageSize | Integer | 每页大小 | ||
| total | Integer | 总记录数 |
表 Data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskPayload | String | 入参内容 | ||
| method | String | 方法，GET/POST等HTTP方法 | ||
| taskId | String | 任务ID | ||
| status | String | 异步任务执行状态。 Enqueued：异步消息已入队，等待处理。 Succeeded：调用执行成功。 Failed：调用执行失败。 Running：调用执行中。 Stopped：调用执行终止。 Stopping：执行停止中。 Invalid：执行因函数被删除等原因处于无效状态（任务未被执行）。 Expired：为任务配置了最长排队等待的期限。该任务因为超期被丢弃（任务未被执行）。 Retrying：异步调用因执行错误重试中。 |
||
| startTime | Integer | 异步任务开始时间，单位为毫秒 | ||
| endTime | Integer | 异步任务结束时间，单位为毫秒 | ||
| durationMs | Integer | 异步任务的执行时长，单位为毫秒 | ||
| alreadyRetriedTimes | Integer | 已重试次数 |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/functions/{functionName}/async-tasks
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"pagination": {
"pageIndex": 2,
"pageSize": 10,
"total": 60
},
"data": [
{
"taskId": "1-6657f501-157eb814-c15cbd059541",
"status": "Succeeded",
"startTime": 1633449590000,
"endTime": 1043826655650,
"durationMs": 1000,
"alreadyRetriedTimes": 3,
"taskPayload": "abc",
"method": "GET"
},
{
"taskId": "1-6657f4d9-157eb814-26d2654f33d9",
"status": "Succeeded",
"startTime": 1633449590000,
"endTime": 1043826655650,
"durationMs": 2000,
"alreadyRetriedTimes": 2,
"taskPayload": "def",
"method": "GET"
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
