1. 接口描述
接口请求域名: scf.tencentcloudapi.com 。
拉取函数异步事件列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListAsyncEvents。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
FunctionName | 是 | String | 函数名称 示例值:helloworld |
Namespace | 否 | String | 命名空间 示例值:default |
Qualifier | 否 | String | 过滤条件,函数版本 示例值:$LATEST |
InvokeType.N | 否 | Array of String | 过滤条件,调用类型列表 示例值:[COS] |
Status.N | 否 | Array of String | 过滤条件,事件状态列表 示例值:RUNNING |
StartTimeInterval | 否 | TimeInterval | 过滤条件,开始执行时间左闭右开区间 |
EndTimeInterval | 否 | TimeInterval | 过滤条件,结束执行时间左闭右开区间 |
Order | 否 | String | 可选值 ASC 和 DESC,默认 DESC 示例值:DESC |
Orderby | 否 | String | 可选值 StartTime 和 EndTime,默认值 StartTime 示例值:StartTime |
Offset | 否 | Integer | 数据偏移量,默认值为 0 示例值:0 |
Limit | 否 | Integer | 返回数据长度,默认值为 20,最大值 100 示例值:20 |
InvokeRequestId | 否 | String | 过滤条件,事件调用请求id 示例值:5f825fd3-a59d-4879-aa28-3ac967c128885f825fd3-a59d-4879-aa28-3ac9 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 满足过滤条件的事件总数 示例值:100 |
EventList | Array of AsyncEvent | 异步事件列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取函数异步事件列表
输入示例
https://scf.tencentcloudapi.com/?Action=ListAsyncEvents
&FunctionName=helloworld
&Qualifier=1
&Offset=0
&Limit=20
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 2,
"EventList": [
{
"InvokeRequestId": "xxxxxxxxxxxxxx",
"Qualifier": "1",
"Status": "FINISHED",
"InvokeType": "COS",
"StartTime": "2020-12-01 08:35:00.000",
"EndTime": "2020-12-01 08:35:30.000"
},
{
"InvokeRequestId": "xxxxxxxxxxxxxx",
"Qualifier": "1",
"Status": "RUNNING",
"InvokeType": "COS",
"StartTime": "2020-12-01 08:35:00.000",
"EndTime": ""
}
],
"RequestId": "26c5f1a9-ebd4-407e-83d7-ae8001cca644"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.FunctionName | 函数不存在。 |
InvalidParameterValue.InvokeType | InvokeType取值与规范不符,请修正后再试。 |
InvalidParameterValue.Limit | Limit传入错误。 |
InvalidParameterValue.Namespace | Namespace参数传入错误。 |
InvalidParameterValue.Order | Order传入错误。 |
InvalidParameterValue.Orderby | Orderby传入错误。 |
InvalidParameterValue.Status | Status取值与规范不符,请修正后再试。 |
ResourceNotFound.Function | 函数不存在。 |
ResourceNotFound.Namespace | Namespace不存在。 |
ResourceNotFound.Version | 版本不存在。 |