文档中心>API 中心>云函数>函数相关接口>获取函数单个请求运行状态

获取函数单个请求运行状态

最近更新时间:2024-10-10 01:27:44

我的收藏

1. 接口描述

接口请求域名: scf.tencentcloudapi.com 。

该接口根据指定的查询条件返回函数单个请求运行状态。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetRequestStatus。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
FunctionName String 函数名称
示例值:hello
FunctionRequestId String 需要查询状态的请求 id
Namespace String 函数的所在的命名空间
StartTime String 查询的开始时间,例如:2017-05-16 20:00:00,不填默认为当前时间 - 15min
示例值:2017-05-16 20:00:00
EndTime String 查询的结束时间,例如:2017-05-16 20:59:59。StartTime 为空时,EndTime 默认为当前时间;StartTime 有值时,需要同时传 EndTime。EndTime 需要晚于 StartTime。
示例值:2017-05-16 20:59:59

3. 输出参数

参数名称 类型 描述
TotalCount Integer 函数运行状态的总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Data Array of RequestStatus 函数运行状态数组
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取函数运行状态

输入示例

https://scf.tencentcloudapi.com/?Action=GetRequestStatus
&FunctionName=<FunctionName>
&FunctionRequestId=<FunctionRequestId>
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Data": [
            {
                "FunctionName": "abc",
                "RetMsg": "abc",
                "RequestId": "abc",
                "StartTime": "abc",
                "RetCode": 0,
                "Duration": 0,
                "MemUsage": 0,
                "RetryNum": 0
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.QueryError 查询失败。
FailedOperation.TopicNotExist Topic不存在。
InternalError 内部错误。
InternalError.System 内部系统错误。
InvalidParameter.Cls 日志参数有误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DateTime DateTime传入错误。
InvalidParameterValue.FunctionName 函数不存在。
InvalidParameterValue.FunctionRequestId 请求 id 传参错误。
InvalidParameterValue.RetCode RetCode不合法。
InvalidParameterValue.StartTime 起始时间传入错误。
InvalidParameterValue.StartTimeOrEndTime 需要同时指定开始日期与结束日期。
OperationDenied.AccountIsolate 账号已被隔离。
OperationDenied.AccountNotExists 账号不存在。
ResourceNotFound.Function 函数不存在。
ResourceNotFound.FunctionName 函数不存在。