最佳实践

获取函数详细信息

最近更新时间:2021-08-03 08:08:21

我的收藏

1. 接口描述

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

该接口获取某个函数的详细信息,包括名称、代码、处理方法、关联触发器和超时时间等字段。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:scf.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetFunction。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
FunctionName String 需要获取详情的函数名称
Qualifier String 函数的版本号
Namespace String 函数所属命名空间
ShowCode String 是否显示代码, TRUE表示显示代码,FALSE表示不显示代码,大于1M的入口文件不会显示

3. 输出参数

参数名称 类型 描述
ModTime Timestamp 函数的最后修改时间
CodeInfo String 函数的代码
Description String 函数的描述信息
Triggers Array of Trigger 函数的触发器列表
Handler String 函数的入口
CodeSize Integer 函数代码大小
Timeout Integer 函数的超时时间
FunctionVersion String 函数的版本
MemorySize Integer 函数的最大可用内存
Runtime String 函数的运行环境
FunctionName String 函数的名称
VpcConfig VpcConfig 函数的私有网络
UseGpu String 是否使用GPU
Environment Environment 函数的环境变量
CodeResult String 代码是否正确
CodeError String 代码错误信息
ErrNo Integer 代码错误码
Namespace String 函数的命名空间
Role String 函数绑定的角色
InstallDependency String 是否自动安装依赖
Status String 函数状态,状态值及流转参考说明
StatusDesc String 状态描述
ClsLogsetId String 日志投递到的Cls日志集
ClsTopicId String 日志投递到的Cls Topic
FunctionId String 函数ID
Tags Array of Tag 函数的标签列表
EipConfig EipOutConfig EipConfig配置
AccessInfo AccessInfo 域名信息
Type String 函数类型,取值为HTTP或者Event
L5Enable String 是否启用L5
Layers Array of LayerVersionInfo 函数关联的Layer版本信息
DeadLetterConfig DeadLetterConfig 函数关联的死信队列信息
AddTime Timestamp 函数创建回见
PublicNetConfig PublicNetConfigOut 公网访问配置
注意:此字段可能返回 null,表示取不到有效值。
OnsEnable String 是否启用Ons
注意:此字段可能返回 null,表示取不到有效值。
CfsConfig CfsConfig 文件系统配置参数,用于云函数挂载文件系统
注意:此字段可能返回 null,表示取不到有效值。
AvailableStatus String 函数的计费状态,状态值参考此处
注意:此字段可能返回 null,表示取不到有效值。
Qualifier String 函数版本
注意:此字段可能返回 null,表示取不到有效值。
InitTimeout Integer 函数初始化超时时间
StatusReasons Array of StatusReason 函数状态失败原因
注意:此字段可能返回 null,表示取不到有效值。
AsyncRunEnable String 是否开启异步属性
注意:此字段可能返回 null,表示取不到有效值。
TraceEnable String 是否开启事件追踪
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取函数详细信息

用户用此函数获取对应的函数信息,可指定版本与命名空间。

输入示例

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

输出示例

{
"Response": {
  "ModTime": "2020-09-22 00:00:00",
  "Layers": [
    {
      "Status": "xx",
      "LayerVersion": 0,
      "Description": "xx",
      "LicenseInfo": "xx",
      "AddTime": "xx",
      "CompatibleRuntimes": [
        "xx"
      ],
      "LayerName": "xx"
    }
  ],
  "CodeError": "xx",
  "AccessInfo": {
    "Host": "xx",
    "Vip": "xx"
  },
  "UseGpu": "xx",
  "EipConfig": {
    "EipFixed": "xx",
    "Eips": [
      "xx"
    ]
  },
  "Namespace": "xx",
  "Environment": {
    "Variables": [
      {
        "Value": "xx",
        "Key": "xx"
      }
    ]
  },
  "OnsEnable": "xx",
  "InstallDependency": "xx",
  "Role": "xx",
  "StatusReasons": [
    {
      "ErrorCode": "xx",
      "ErrorMessage": "xx"
    }
  ],
  "Description": "xx",
  "Type": "xx",
  "Status": "xx",
  "Runtime": "xx",
  "DeadLetterConfig": {
    "FilterType": "xx",
    "Type": "xx",
    "Name": "xx"
  },
  "Qualifier": "xx",
  "Tags": [
    {
      "Value": "xx",
      "Key": "xx"
    }
  ],
  "ClsLogsetId": "xx",
  "FunctionId": "xx",
  "FunctionVersion": "xx",
  "FunctionName": "xx",
  "Triggers": [
    {
      "ModTime": "2020-09-22 00:00:00",
      "BindStatus": "xx",
      "Enable": 0,
      "TriggerAttribute": "xx",
      "Qualifier": "xx",
      "CustomArgument": "xx",
      "AddTime": "2020-09-22 00:00:00",
      "AvailableStatus": "xx",
      "TriggerDesc": "xx",
      "TriggerName": "xx",
      "ResourceId": "xx",
      "Type": "xx"
    }
  ],
  "ClsTopicId": "xx",
  "AddTime": "2020-09-22 00:00:00",
  "MemorySize": 128,
  "CfsConfig": {
    "CfsInsList": [
      {
        "MountSubnetId": "xx",
        "LocalMountDir": "xx",
        "UserId": "xx",
        "IpAddress": "xx",
        "MountInsId": "xx",
        "MountVpcId": "xx",
        "UserGroupId": "xx",
        "CfsId": "xx",
        "RemoteMountDir": "xx"
      }
    ]
  },
  "Timeout": 3,
  "StatusDesc": "xx",
  "TraceEnable": "xx",
  "CodeInfo": "xx",
  "AsyncRunEnable": "xx",
  "VpcConfig": {
    "SubnetId": "xx",
    "VpcId": "xx"
  },
  "ErrNo": 0,
  "CodeSize": 0,
  "L5Enable": "xx",
  "AvailableStatus": "xx",
  "Handler": "xx",
  "CodeResult": "xx",
  "PublicNetConfig": {
    "EipConfig": {
      "EipAddress": [
        "xx"
      ],
      "EipStatus": "xx"
    },
    "PublicNetStatus": "xx"
  },
  "InitTimeout": 0,
  "RequestId": "xx"
}
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.Apigw 创建触发器失败。
InternalError 内部错误。
InternalError.Exception 内部服务异常。
InternalError.System 内部系统错误。
InvalidParameter.Payload 请求参数不合法。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.CodeSecret CodeSecret传入错误。
InvalidParameterValue.FunctionName 函数不存在。
InvalidParameterValue.Namespace Namespace参数传入错误。
InvalidParameterValue.Qualifier 不支持的函数版本。
ResourceNotFound.Function 函数不存在。
ResourceNotFound.FunctionName 函数不存在。
ResourceNotFound.Namespace Namespace不存在。
ResourceNotFound.Version 版本不存在。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.CAM CAM鉴权失败。
UnauthorizedOperation.CodeSecret 无访问代码权限。
目录