1. 接口描述
接口请求域名: scf.tencentcloudapi.com 。
该接口根据指定的日志查询条件返回函数运行日志。该接口已下线,查询函数请求运行的返回信息,请使用 GetRequestStatus。查询函数运行日志,请参考日志检索教程。
默认接口请求频率限制:5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetFunctionLogs。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
FunctionName | 否 | String | 函数的名称。 - 为保证获取函数运行日志接口 GetFunctionLogs 兼容性,输入参数FunctionName 仍为非必填项,但建议填写该参数,否则可能导致日志获取失败。- 函数关联日志服务后,建议使用日志服务相关接口以获得最佳日志检索体验。 示例值:helloworld-demo |
Offset | 否 | Integer | 数据的偏移量,Offset+Limit不能大于10000 示例值:0 |
Limit | 否 | Integer | 返回数据的长度,Offset+Limit不能大于10000 示例值:20 |
Order | 否 | String | 以升序还是降序的方式对日志进行排序,可选值 desc和 asc 示例值:desc |
OrderBy | 否 | String | 根据某个字段排序日志,支持以下字段:function_name, duration, mem_usage, start_time 示例值:function_name |
Filter | 否 | LogFilter | 日志过滤条件。可用来区分正确和错误日志,filter.RetCode=not0 表示只返回错误日志,filter.RetCode=is0 表示只返回正确日志,不传,则返回所有日志 示例值:not0 |
Namespace | 否 | String | 函数的命名空间 示例值:default |
Qualifier | 否 | String | 函数的版本 示例值:$LATEST |
FunctionRequestId | 否 | String | 执行该函数对应的requestId 示例值:d1922633-55cf-443a-a6cc-0788ce93df06 |
StartTime | 否 | Timestamp | 查询的具体日期,例如:2017-05-16 20:00:00,只能与endtime相差一天之内 示例值:2017-05-16 20:00:00 |
EndTime | 否 | Timestamp | 查询的具体日期,例如:2017-05-16 20:59:59,只能与startTime相差一天之内 示例值:2017-05-16 20:59:59 |
SearchContext | 否 | LogSearchContext | 该字段已下线 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 函数日志的总数 示例值:100 |
Data | Array of FunctionLog | 函数日志信息 |
SearchContext | LogSearchContext | 该字段已下线 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取函数运行日志
获取函数运行日志
输入示例
https://scf.tencentcloudapi.com/?Action=GetFunctionLogs
&FunctionName=<FunctionName>
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"Data": [
{
"MemUsage": 3174400,
"RetCode": 1,
"RetMsg": "Success",
"Log": "",
"BillDuration": 100,
"InvokeFinished": 1,
"RequestId": "bc309eaa-6d64-11e8-a7fe-5254000b4175",
"StartTime": "2018-06-11 18:46:45",
"Duration": 0.532,
"FunctionName": "APITest",
"Level": "",
"Source": "",
"RetryNum": 1
}
],
"SearchContext": {
"Offset": "",
"Limit": 0,
"Keyword": "",
"Type": ""
},
"RequestId": "e2571ff3-da04-4c53-8438-f58bf057ce4a"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.AuthFailure | 登录信息验证失败,token 验证失败。 |
FailedOperation.QueryError | 查询失败。 |
FailedOperation.TopicNotExist | Topic不存在。 |
InternalError | 内部错误。 |
InternalError.ES | ES错误。 |
InternalError.Exception | 内部服务异常。 |
InternalError.System | 内部系统错误。 |
InvalidParameter.Cls | 日志参数有误。 |
InvalidParameter.ParamError | 创建函数传参异常。 |
InvalidParameter.Payload | 请求参数不合法。 |
InvalidParameter.RoleCheck | RoleCheck 传参有误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.DateTime | DateTime传入错误。 |
InvalidParameterValue.FunctionType | FunctionType参数错误。 |
InvalidParameterValue.ImageType | ImageType 参数值有误。 |
InvalidParameterValue.Offset | 偏移量不合法。 |
InvalidParameterValue.Order | Order传入错误。 |
InvalidParameterValue.OrderBy | OrderBy取值与规范不符,请修正后再试。可参考:https://tencentcs.com/5jXKFnBW。 |
InvalidParameterValue.RetCode | RetCode不合法。 |
InvalidParameterValue.StartTimeOrEndTime | 需要同时指定开始日期与结束日期。 |
LimitExceeded.Offset | Offset超出限制。 |
ResourceNotFound.Function | 函数不存在。 |
ResourceNotFound.FunctionName | 函数不存在。 |
ResourceNotFound.RoleCheck | Role不存在。 |
UnauthorizedOperation.CAM | CAM鉴权失败。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.NotSupportRegion | 不支持的地域。 |