1. 接口描述
接口请求域名: scf.tencentcloudapi.com 。
该接口获取某个函数的详细信息,包括名称、代码、处理方法、关联触发器和超时时间等字段。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetFunction。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。 |
FunctionName | 否 | String | 需要获取详情的函数名称,ResourceId和FunctionName只能传一个 示例值: |
Qualifier | 否 | String | 函数的版本号 默认值: $LATEST 示例值:$LATEST |
Namespace | 否 | String | 函数所属命名空间 默认值: default 示例值:default |
ShowCode | 否 | String | 是否显示代码, TRUE表示显示代码,FALSE表示不显示代码,大于1M的入口文件不会显示 示例值:TRUE |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ModTime | Timestamp | 函数的最后修改时间 示例值:2018-06-07 09:52:23 |
CodeInfo | String | 函数的代码 |
Description | String | 函数的描述信息 示例值:这是一个云函数 |
Triggers | Array of Trigger | 函数的触发器列表 |
Handler | String | 函数的入口 示例值:scfredis.main_handler |
CodeSize | Integer | 函数代码大小 示例值:0 |
Timeout | Integer | 函数的超时时间 示例值:3 |
FunctionVersion | String | 函数的版本 示例值:$LATEST |
MemorySize | Integer | 函数的最大可用内存 示例值:128 |
Runtime | String | 函数的运行环境 注意:此字段可能返回 null,表示取不到有效值。 示例值:Python2.7 |
FunctionName | String | 函数的名称 示例值:ledDummyAPITest |
VpcConfig | VpcConfig | 函数的私有网络 |
UseGpu | String | 是否使用GPU 示例值:FALSE |
Environment | Environment | 函数的环境变量 |
CodeResult | String | 代码是否正确 示例值:failed |
CodeError | String | 代码错误信息 |
ErrNo | Integer | 代码错误码 示例值:0 |
Namespace | String | 函数的命名空间 示例值:default |
Role | String | 函数绑定的角色 |
InstallDependency | String | 是否自动安装依赖 示例值:FALSE |
Status | String | 函数状态,状态值及流转参考说明 示例值:Active |
StatusDesc | String | 状态描述 |
ClsLogsetId | String | 日志投递到的Cls日志集 示例值:5354061a-dcaa-46be-8359-fe5gt56075c0 |
ClsTopicId | String | 日志投递到的Cls Topic 示例值:5354061a-dcaa-46be-jydw-fe51e56075c0 |
FunctionId | String | 函数ID 示例值:lam-bcrxav2w |
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,表示取不到有效值。 示例值:Available |
Qualifier | String | 函数版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:$LATEST |
InitTimeout | Integer | 函数初始化超时时间 |
StatusReasons | Array of StatusReason | 函数状态失败原因 注意:此字段可能返回 null,表示取不到有效值。 |
AsyncRunEnable | String | 是否开启异步属性 注意:此字段可能返回 null,表示取不到有效值。 |
TraceEnable | String | 是否开启事件追踪 注意:此字段可能返回 null,表示取不到有效值。 |
ImageConfig | ImageConfig | 镜像配置 注意:此字段可能返回 null,表示取不到有效值。 |
ProtocolType | String | HTTP函数支持的访问协议。当前支持WebSockets协议。 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
ProtocolParams | ProtocolParams | HTTP函数配置ProtocolType访问协议,当前协议配置的参数 注意:此字段可能返回 null,表示取不到有效值。 |
DnsCache | String | 是否开启DNS缓存 注意:此字段可能返回 null,表示取不到有效值。 |
IntranetConfig | IntranetConfigOut | 内网访问配置 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取函数详细信息
用户用此函数获取对应的函数信息,可指定版本与命名空间。
输入示例
POST / HTTP/1.1
Host: scf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFunction
<公共请求参数>
{
"FunctionName": "<FunctionName>"
}
输出示例
{
"Response": {
"ModTime": "2020-09-22 00:00:00",
"CodeInfo": "abc",
"Description": "abc",
"Triggers": [
{
"ModTime": "2020-09-22 00:00:00",
"Type": "abc",
"TriggerDesc": "abc",
"TriggerName": "abc",
"AddTime": "2020-09-22 00:00:00",
"Enable": 0,
"CustomArgument": "abc",
"AvailableStatus": "abc",
"ResourceId": "abc",
"BindStatus": "abc",
"TriggerAttribute": "abc",
"Qualifier": "abc",
"Description": "abc"
}
],
"Handler": "abc",
"CodeSize": 0,
"Timeout": 0,
"FunctionVersion": "abc",
"MemorySize": 0,
"Runtime": "abc",
"FunctionName": "abc",
"VpcConfig": {
"VpcId": "abc",
"SubnetId": "abc"
},
"UseGpu": "abc",
"Environment": {
"Variables": [
{
"Key": "abc",
"Value": "abc"
}
]
},
"CodeResult": "abc",
"CodeError": "abc",
"ErrNo": 0,
"Namespace": "abc",
"Role": "abc",
"InstallDependency": "abc",
"Status": "abc",
"StatusDesc": "abc",
"ClsLogsetId": "abc",
"ClsTopicId": "abc",
"FunctionId": "abc",
"Tags": [
{
"Key": "abc",
"Value": "abc"
}
],
"EipConfig": {
"EipFixed": "abc",
"Eips": [
"abc"
]
},
"AccessInfo": {
"Host": "abc",
"Vip": "abc"
},
"Type": "abc",
"L5Enable": "abc",
"Layers": [
{
"CompatibleRuntimes": [
"abc"
],
"AddTime": "abc",
"Description": "abc",
"LicenseInfo": "abc",
"LayerVersion": 0,
"LayerName": "abc",
"Status": "abc",
"Stamp": "abc"
}
],
"DeadLetterConfig": {
"Type": "abc",
"Name": "abc",
"FilterType": "abc"
},
"AddTime": "2020-09-22 00:00:00",
"PublicNetConfig": {
"PublicNetStatus": "abc",
"EipConfig": {
"EipStatus": "abc",
"EipAddress": [
"abc"
]
}
},
"OnsEnable": "abc",
"CfsConfig": {
"CfsInsList": [
{
"UserId": "abc",
"UserGroupId": "abc",
"CfsId": "abc",
"MountInsId": "abc",
"LocalMountDir": "abc",
"RemoteMountDir": "abc",
"IpAddress": "abc",
"MountVpcId": "abc",
"MountSubnetId": "abc"
}
]
},
"AvailableStatus": "abc",
"Qualifier": "abc",
"InitTimeout": 0,
"StatusReasons": [
{
"ErrorCode": "abc",
"ErrorMessage": "abc"
}
],
"AsyncRunEnable": "abc",
"TraceEnable": "abc",
"ImageConfig": {
"RegistryId": "abc",
"ImageType": "abc",
"ImageUri": "abc",
"EntryPoint": "abc",
"Command": "abc",
"Args": "abc",
"ContainerImageAccelerate": true,
"ImagePort": 0
},
"ProtocolType": "abc",
"ProtocolParams": {
"WSParams": {
"IdleTimeOut": 1
}
},
"DnsCache": "abc",
"IntranetConfig": {
"IpFixed": "abc",
"IpAddress": [
"abc"
]
},
"RequestId": "abc"
}
}
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.Apigw | 创建触发器失败。 |
FailedOperation.CallNetDeployFailed | 调用 NetDeploy 失败。 |
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 | 无访问代码权限。 |