获取函数详细信息，包含函数配置及函数代码。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetFunction | 接口名称。当前 API 的名称为 GetFunction。 |
| Version | String | 是 | 2024-06-06 | 接口版本。当前 API 的版本为 2024-06-06。 |
| Id | String | 是 | pqyqo9qa | 函数 ID。 |
POST http://open.volcengineapi.com/?Action=GetFunction&Version=2024-06-06 HTTP/1.1 Content-Type: application/json { "Id": "pqyqo9qa" }
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | String | pqyqo9qa | 函数 ID。 |
| Name | String | official-site | 函数名称。 |
| Description | String | 轻量级官网 | 函数描述。 |
| Runtime | String | python3.8/v1 | 函数运行时。 |
ExclusiveMode | Boolean | false | 独占模式开关。
|
| RequestTimeout | Integer | 30 | 请求超时（单位 秒）。 |
| MaxConcurrency | Integer | 100 | 单实例最大并发。 |
| MemoryMB | Integer | 1024 | 单实例最大内存。 |
| CodeSize | Integer | 473 | 代码包大小。 |
CodeSizeLimit | Integer | 256 | 代码包大小上限。
|
| SourceLocation | String | https://vefaas.tos-s3-cn.volces.com/template_dir/666ad75b9124c400072abcvefaas-python3.9-default.zip?X-Amz****** | 代码/镜像的来源地址。 |
SourceType | String | tos | 代码来源类型，可选值有：
|
| Envs | Array of EnvVar | - | 函数环境变量。 |
| VpcConfig | Object of VpcConfig | - | VPC 配置。 |
| CreationTime | String | 2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864 | 创建时间。 |
| LastUpdateTime | String | 2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914 | 更新时间。 |
| TlsConfig | Object of TlsConfig | - | 函数日志配置。 |
| Owner | String | 22****** | 函数所有者（账号 Id）。 |
| TriggersCount | Integer | 0 | 该函数的触发器个数。 |
InstanceType | String | nvidia-tesla-l4 | 函数实例的实例类型。
|
| NasStorage | Object of NasStorage | - | 文件存储 NAS 挂载配置。 |
| TosMountConfig | Object of TosMountConfig | - | 对象存储 TOS 挂载配置。 |
| InitializerSec | Integer | 30 | 函数初始化超时配置。 |
| Command | String | ./run.sh | 实例的自定义启动命令（目前只支持 native/v1 运行时）。 |
| Port | Integer | 8000 | 实例的自定义监听端口（目前只支持 native/v1 运行时）。 |
| CpuStrategy | String | always | 函数 CPU 计费策略，当微服务应用类型的函数时，该字段为 always，表示至少有一个实例在运行。 |
| ProjectName | String | default | 项目名称 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | business_type | 环境变量的 Key。1 ~ 63 个字符，字符中可包含英文、数字以及下划线（_），并且不能以数字开头。同一函数下 Key 唯一。 |
| Value | String | free | 环境变量的值。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| VpcId | String | vpc-3rf8****** | VPC ID。如果 VPC ID 为空字符串，代表删除当前 VPC 配置。 |
| EnableVpc | Boolean | false | 函数是否开启私有网络访问。 |
| SubnetIds | Array of String | subnet-mj1l****** | 子网 ID。 |
| SecurityGroupIds | Array of String | sg-rs6s****** | 安全组 ID。 |
EnableSharedInternetAccess | Boolean | false | 函数访问公网开关。是否通过 veFaaS 的 VPC 共享 NAT 网关，访问公网。取值：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
EnableLog | Boolean | false | TLS 日志功能开关。
|
| TlsTopicId | String | tls-vefaas-logstore | TLS 日志主题 ID。 |
| TlsProjectId | String | tls-vefaas | TLS 日志项目 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
EnableNas | Boolean | false | 是否开启 NAS 存储挂载。
|
| NasConfigs | Array of NasConfig | - | NAS 存储配置。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| EnableTos | Boolean | false | 是否开启 TOS 存储挂载。 |
| Credentials | Object of Credentials | - | 开启 TOS 后需要提供具有 TOS 域名访问权限的 AKSK。 |
| MountPoints | Array of TosMountPoint | - | 开启 TOS 后需要提供 TOS 存储配置列表，最多不超过 5 个。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Gid | Long | 1000 | 文件系统中的用户组，暂时不支持自定义，如果提供该参数，参数值 1000（和函数 run user gid 保持一致）。 |
| Uid | Long | 1000 | 文件系统中的用户，暂时不支持自定义，如果提供该参数，参数值只能为 1000（和函数 run user uid 保持一致）。 |
| RemotePath | String | / | 文件系统远端目录。长度 1-128 个字符，只能以“/”开头，支持大小写字母、数字和特殊字符（- . _ ~ / : @ = + ? # ）。 |
| FileSystemId | String | enas-cns****** | NAS 文件系统 ID。 |
| MountPointId | String | mount-63****** | NAS 挂载点 ID。 |
| LocalMountPath | String | /mnt/nas | 函数本地挂载目录。长度 1-128 个字符，只能以“/”开头，支持大小写字母、数字和特殊字符（- . _ ~ / : @ = + ? # ）。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AccessKeyId | String | ****** | 火山引擎账号的 AccessKey ID（AK）。获取方式，请参见 访问密钥使用指南。 |
| SecretAccessKey | String | ****** | 火山引擎账号的 Secret Access Key（SK）。获取方式，请参见 访问密钥使用指南。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Endpoint | String | http://tos-cn-beijing.ivolces.com | TOS 访问域名。 |
ReadOnly | Boolean | true | 函数本地目录访问权限，挂载 TOS Bucket后，函数本地挂载目录的访问权限是否为只读。
|
| BucketName | String | ai-model | TOS 存储桶。 |
| BucketPath | String | / | 挂载的 TOS Bucket 路径。 |
| LocalMountPath | String | /mnt/tos | 函数本地挂载目录。 |
HTTP/1.1 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "202306041104231", "Action": "GetFunction", "Version": "2024-06-06", "Service": "vefaas", "Region": "cn-beijing" }, "Result": { "Id": "pqyqo9qa", "Name": "official-site", "Description": "轻量级官网", "Runtime": "python3.8/v1", "ExclusiveMode": true, "RequestTimeout": 30, "MaxConcurrency": 100, "MemoryMB": 1024, "CodeSize": 473, "CodeSizeLimit": 256, "SourceLocation": "https://vefaas.tos-s3-cn.volces.com/template_dir/666ad75b9124c400072abcvefaas-python3.9-default.zip?X-Amz-******", "SourceType": "tos", "Envs": [ { "Key": "business_type", "Value": "free" } ], "VpcConfig": { "EnableVpc": true, "VpcId": "vpc-rrag******", "SubnetIds": [ "subnet-milb******" ], "SecurityGroupIds": [ "sg-rra******" ], "EnableSharedInternetAccess": true }, "CreationTime": "2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864", "LastUpdateTime": "2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914", "TlsConfig": { "EnableLog": true, "TlsProjectId": "a40202c5-fe22-4ea7******", "TlsTopicId": "2ff955cb-1f03-4b9b-******" }, "ResourcePoolId": "ujdsugabcd", "Owner": "1400001234", "TriggersCount": 0, "UseStatus": "normal", "DebugInstanceEnable": true, "InstanceType": "unlocked", "NasStorage": { "EnableNas": true, "NasConfigs": [ { "FileSystemId": "cnas-cnbj******", "MountPointId": "mount-bce15678", "RemotePath": "/", "LocalMountPath": "/mnt/nas", "Uid": 1000, "Gid": 1000 } ] }, "TosMountConfig": { "EnableTos": true, "MountPoints": [ { "Endpoint": "http://tos-cn-beijing.ivolces.com", "BucketName": "ai-models", "BucketPath": "/", "LocalMountPath": "/mnt/tos", "ReadOnly": false } ] }, "InitializerSec": 30 } }
当前接口暂无独立错误码，若接口调用返回异常，可参考 公共错误码 进行故障排查。