1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
获取云函数详情
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetFunction。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境Id 示例值:cbf-wushan-d8gg2hg8mae294e31 |
| FunctionName | 否 | String | 函数名 示例值:jackvylitest7 |
| Qualifier | 否 | String | 函数的版本 示例值:$LATEST |
| Namespace | 否 | String | 环境 示例值:cbf-wushan-d8gg2hg8mae294e31 |
| ShowCode | 否 | String | 是否返回代码 示例值:TRUE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ModTime | String | 函数最后修改时间 示例值:2026-08-20 10:53:26 |
| CodeInfo | String | 函数代码(>1M 不返回) 示例值:exports.main = async (event, context) => {\n return { \n "hello": "world",\n "event": event,\n "context": context\n }\n} |
| Description | String | 函数描述 示例值:Hello World |
| Triggers | Array of FunctionTrigger | 触发器列表 注意:此字段可能返回 null,表示取不到有效值。 |
| Handler | String | 入口函数 示例值:index.main |
| CodeSize | Integer | 代码大小(字节) 示例值:0 |
| Timeout | Integer | 超时时间(秒) 示例值:3 |
| FunctionVersion | String | 函数版本 示例值:$LATEST |
| MemorySize | Integer | 内存大小(MB) 示例值:256 |
| Runtime | String | 运行环境 示例值:Nodejs18.15 |
| FunctionName | String | 函数名称 示例值:autotest |
| VpcConfig | FunctionVpcConfig | VPC 配置 注意:此字段可能返回 null,表示取不到有效值。 |
| UseGpu | String | 是否使用 GPU ("TRUE"/"FALSE") 示例值:FALSE |
| CodeResult | String | 代码校验结果 ("success"/"failed") 示例值:success |
| ErrNo | Integer | 代码错误码 示例值:0 |
| Namespace | String | 命名空间 示例值:cbf-wushan-d8gg2hg8mae294e31 |
| Role | String | 角色 示例值:TCB_QcsRole |
| InstallDependency | String | 是否自动安装依赖 ("TRUE"/"FALSE") 示例值:TRUE |
| Status | String | 函数状态 ("Active", "Inactive" 等) 示例值:Creating |
| FunctionId | String | 函数 ID 示例值:lam-0qxuqwmn |
| Tags | Array of Tag | 标签列表 注意:此字段可能返回 null,表示取不到有效值。 |
| Type | String | 函数类型 ("HTTP" 或 "Event") 示例值:HTTP |
| L5Enable | String | 是否启用 L5 ("TRUE"/"FALSE") 示例值:FALSE |
| AddTime | String | 函数创建时间 示例值:2026-08-20 10:53:26 |
| OnsEnable | String | 对应scf.GetFunction接口的OnsEnable,是否启用 Ons ("TRUE"/"FALSE") 示例值:FALSE |
| AvailableStatus | String | 计费状态 ("Available" 等) 示例值:Available |
| Qualifier | String | 函数版本(查询时传入的) 示例值:$LATEST |
| InitTimeout | Integer | 初始化超时时间(秒) 示例值:65 |
| AsyncRunEnable | String | 是否开启异步 ("TRUE"/"FALSE") 示例值:FALSE |
| TraceEnable | String | 是否开启事件追踪 ("TRUE"/"FALSE") 示例值:FALSE |
| ImageConfig | AgentRuntimeCodeImageConfig | 镜像配置 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 GetFunction-0819
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFunction
<公共请求参数>
{
"EnvId": "jackvyli-d1g5v7p5e7191af47",
"FunctionName": "jackvylitest7",
"Namespace": "jackvyli-d1g5v7p5e7191af47"
}
输出示例
{
"Response": {
"AddTime": "2026-08-20 10:53:26",
"AsyncRunEnable": "FALSE",
"AvailableStatus": "Available",
"CodeInfo": "",
"CodeResult": "success",
"CodeSize": 0,
"Description": "Hello World",
"ErrNo": 0,
"FunctionId": "lam-bl4u8z57",
"FunctionName": "jackvylitest7",
"FunctionVersion": "$LATEST",
"Handler": "",
"ImageConfig": {
"Args": "",
"Command": "",
"ContainerImageAccelerate": false,
"ImageType": "",
"ImageUri": "",
"RegistryId": ""
},
"InitTimeout": 65,
"InstallDependency": "TRUE",
"L5Enable": "FALSE",
"MemorySize": 256,
"ModTime": "2026-08-20 10:53:26",
"Namespace": "jackvyli-d1g5v7p5e7191af47",
"OnsEnable": "FALSE",
"Qualifier": "$LATEST",
"RequestId": "94070739-c916-496b-9e2a-3f93cf69fc9d",
"Role": "TCB_QcsRole",
"Runtime": "Nodejs18.15",
"Status": "Creating",
"Tags": [],
"Timeout": 3,
"TraceEnable": "FALSE",
"Triggers": [],
"Type": "HTTP",
"UseGpu": "FALSE",
"VpcConfig": {
"SubnetId": "subnet-2tvkenrt",
"VpcId": "vpc-3m4f4bhq"
}
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.SystemFail | 系统失败。 |
| InvalidParameter.INVALID_PARAM | 请求参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.Function | 函数不存在。 |
| ResourceNotFound.Namespace | Namespace不存在。 |
| UnauthorizedOperation | 未授权操作。 |