接口功能介绍
获取异步任务
接口约束
无
URI
GET /openapi/v1/functions//async-tasks/
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| functionName | 是 | String | 函数名称 | my-func | |
| taskId | 是 | String | 异步任务 ID | e026ae92-61e5-472f-b32d-1c9e3c4e**** |
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| qualifier | 是 | String | 版本或别名 | LATEST |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | test |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码,0表示成功，非0表示不成功 | 0 | |
| error | String | 错误码 | CF_0 | |
| message | String | 信息 | ||
| returnObj | Object | 返回实体 | ReturnObj |
表 ReturnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| startTime | Integer | 异步任务开始时间，单位为毫秒 | ||
| endTime | Integer | 异步任务结束时间，单位为毫秒 | ||
| durationMs | Integer | 异步任务的执行时长，单位为毫秒 | ||
| alreadyRetriedTimes | Integer | 已重试次数 | ||
| method | String | 方法，GET/POST等HTTP方法 | ||
| taskId | String | 任务 ID | ||
| taskPayload | String | 任务入参 | ||
| status | String | 任务状态。 Enqueued：异步消息已入队，等待处理。 Succeeded：调用执行成功。 Failed：调用执行失败。 Running：调用执行中。 Stopped：调用执行终止。 Stopping：执行停止中。 Invalid：执行因函数被删除等原因处于无效状态（任务未被执行）。 Expired：为任务配置了最长排队等待的期限。该任务因为超期被丢弃（任务未被执行）。 Retrying：异步调用因执行错误重试中。 |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/functions/{functionName}/async-tasks/{taskId}
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"taskId": "1-6657f501-157eb814-c15cbd059541",
"taskPayload": "{\n \"key1\": \"value1\",\n \"key2\": \"value2\",\n \"key3\": \"value3\"\n}",
"status": "Succeeded",
"startTime": 1717040385919,
"endTime": 1717040415983,
"durationMs": 30031,
"alreadyRetriedTimes": 3,
"method": "GET"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
