You need to enable JavaScript to run this app.
文档中心
函数服务

函数服务

复制全文
下载 pdf
沙箱应用
沙箱应用
复制全文
下载 pdf
沙箱应用
沙箱应用是云沙箱的基础单元,用于管理资源调度和运行。本文主要介绍函数服务(veFaaS)提供的云沙箱应用相关创建、使用、管理操作。​
创建沙箱应用​
前提条件​
  • 已创建 API 网关实例和服务(域名),用于对外暴露应用接口。详细操作,请参见 创建实例、创建服务。​
  • (可选)若需要使用自定义镜像,请确保已上传镜像到火山引擎镜像仓库(CR)中。详细操作,请参见 基于 Docker 推送和拉取镜像。​
  • (可选)若需要查看函数日志,请确保已开通火山引擎日志服务。其中,使用自定义日志项目投递函数日志时,需确保已创建日志项目和主题。详细操作请参见 创建日志项目、创建日志主题。​
  • (可选)如需访问私有网络 VPC,请确保已开通火山引擎私有网络,已在函数待部署地域创建私有网络、子网和安全组。详细操作请参见 创建私有网络、创建子网、创建安全组。​
操作步骤​
  1. 在顶部导航栏,选择目标地域。​
  1. 左侧导航栏选择 云沙箱 > 沙箱应用,单击 创建沙箱应用。​
  1. 在 创建沙箱应用 页面,按照如下说明配置参数。​
  • ​
    参数​
    说明​
    基础配置​
    ​
    名称​
    自定义沙箱应用名称。同一账号下沙箱应用名称不可重复。创建成功后名称不支持修改。​
    备注​
    沙箱应用的备注信息。可以为空。​
    沙箱镜像​
    ​
    容器镜像​
    通过容器镜像方式部署沙箱应用:​
    • 公共镜像:沙箱镜像预置的开箱即用的公共镜像,可直接使用。​
    • 自定义镜像:从沙箱镜像中选择已预热的镜像。支持通过镜像 ID、镜像地址进行筛选。​
    沙箱镜像说明,请参见 沙箱镜像。​
    启动命令​
    ​
    输入应用程序的启动命令。如需指定脚本文件,请使用绝对路径,并确保脚本具有相应的可执行权限。​
    说明​
    • 容器镜像 选择 公共镜像 时:veFaaS 根据您选择的镜像显示默认启动命令。您可以按需修改。​
    • 容器镜像 选择 自定义镜像 时:veFaaS 自动解析目标镜像配置文件,获取该镜像中的 启动命令 信息。您可以按需修改。​
    监听端口​
    输入 HTTP Server 所监听的端口。​
    注意​
    • 请避免使用 veFaaS 占用的端口:9000、9001、9990。​
    • 您启动的 HTTP Server 需监听0.0.0.0:Port或*:Port。否则会导致请求超时错误。​
    网关路由配置​
    ​
    域名类型​
    沙箱应用的访问域名类型:​
    • 统一域名:沙箱应用中的所有沙箱实例共享一个访问域名。通过 Header 为x-faas-instance-name,或 Query 为faasInstanceName请求指定沙箱实例。​
    • 泛域名:【邀测·申请试用】通过泛域名为每个沙箱实例提供独立的访问入口。​
    沙箱实例相关说明,请参见 沙箱实例。​
    网关实例​
    选择 API 网关实例。沙箱应用将以 API 网关作为流量入口。​
    网关服务​
    选择 API 网关实例对应的服务。​
    路由名称​
    自定义路由名称。路由名称创建成功后不支持修改。​
    Path​
    设置允许访问沙箱应用的请求路径。仅支持前缀匹配,路径必须以/开头。​
    路由鉴权​
    配置 API 网关实例的路由鉴权,保证沙箱应用的路由安全:​
    • 关闭:(默认)不开启鉴权,后续您可以根据自身需求手动开启 Key Auth 鉴权。详细操作,请参见 API Key 认证鉴权。​
    • Key Auth:通过 API 网关使用 Key Auth 插件实现基于 API Key 的认证鉴权。​
    • 选择 Key Auth 后,您还需要进行 认证配置,即选择 Key Auth 认证信息的位置:​
    • header:在请求头中附带 Key Auth 认证信息,默认来源为 Authorization。​
    • querystring:在请求参数中附带 Key Auth 认证信息。默认来源为 token。​
    说明​
    使用 Key Auth 进行鉴权时,API 网关实例版本需在 v3.1 及以上。若版本不满足需求,可通过提交 API 网关工单 或联系您的火山引擎客户经理,升级实例版本。​
    环境变量​
    ​
    环境变量​
    ​
    自定义配置的环境变量,在函数代码运行时可以直接读取到。​
    说明​
    容器镜像 选择 自定义镜像 时:veFaaS 将自动解析目标镜像配置文件,获取该镜像中的 环境变量 信息。您可以按需修改。​
    高级配置​
    详细的参数说明,请参见 函数配置。​
    ​
  1. 阅读并勾选《函数服务专用服务条款》和《函数服务产品服务等级协议》,然后单击 确定,完成沙箱应用的创建。​
管理沙箱应用​
成功创建沙箱应用后,可以查看沙箱应用基本信息、监控和日志等,管理沙箱应用以及创建沙箱实例接口每分钟请求数上限(QPM)。​
  1. 在顶部导航栏,选择目标地域。​
  1. 左侧导航栏选择 云沙箱 > 沙箱应用。​
  1. 在 沙箱应用 列表页面,查看沙箱应用相关信息。​
  • ​
    模块分类​
    说明​
    用户级 QPM 配置​
    【邀测·申请试用】沙箱应用每分钟可发起创建沙箱实例的请求数是有限的,若主账号下不同沙箱应用同一时间段发起创建实例的请求,可能存在资源争抢、高优先级业务应用(例如试试推理应用)资源配额受影响等情况。针对此场景,veFaaS 支持配置用户级别的 QPM,提供资源隔离、优先级保障等能力。​
    通过功能邀测申请后,可在 沙箱应用 页面查看当前用户下所有沙箱应用共享的 QPM 配额。您可以单击 申请用户及配额,通过获取技术支持,更新用户级 QPM 配额。​
    ​​​
    快速部署模板​
    显示 veFaaS 提供的各类沙箱应用模板,供您快速部署沙箱应用。更多说明,请参见 云沙箱模板。​
    沙箱应用信息​
    在沙箱应用列表中,可查看目标沙箱应用的可观测(监控和日志)信息,以及标签、实例数、镜像地址等其他基本信息。​
    ​
  1. 选择一个目标沙箱应用,单击应用名称,进入沙箱应用详情页面管理沙箱应用。​
  • 详情页顶部​
  • 在详情页顶部的右侧支持发布应用、删除应用操作。​
  • 基本信息​
  • ​
    功能模块​
    说明​
    参数配置​
    查看或修改沙箱应用的参数配置。参数相关说明,请参见本文上方 创建沙箱应用。​
    变更提示​
    提供配置变更后的发布提示。应用的配置更新后,控制台将直观展示变更前后的配置差异,清晰呈现修改项,并可以根据提示发布应用。​
    ​
  • 沙箱实例​
  • ​
    功能模块​
    说明​
    资源统计​
    展示当前应用中实例的总数和运行中实例的个数。​
    资源配额​
    支持展示当前资源用量和百分比,并支持单击 申请资源,在 配额中心 申请更多的配额。​
    • 实例数上限:展示当前应用中已创建实例的数量和所占配额上限的百分比。单击 设置,支持调整当前应用可用的实例上限和预热池数量。如需更多实例配置,支持在 配额中心,通过 SandboxFunctionInstancesLimit 参数申请更多资源。​
    • 内存使用量:展示当前应用的内存使用量和占账号总配额的百分比。支持在 配额中心,通过 SandboxMemory 参数申请更多资源。​
    • vCPU 使用量:展示当前应用的 vCPU 使用量和占账号总配额的百分比。支持在 配额中心,通过 SandboxVCPU 参数申请更多资源。​
    • 应用 QPM 上限:【邀测·申请试用】云沙箱的应用级别 QPM 配置,可控制当前沙箱应用中每分钟可发起创建沙箱实例的请求数,从而实现更细粒度的资源配额控制。​
    • 申请功能邀测并通过技术支持首次配置应用级别 QPM 限制后,可在 资源配额 模块中查看该沙箱应用的 QPM 限制。您可以单击 QPM 限制数旁的 申请,通过获取技术支持,更新应用级 QPM 配额。​
    • ​​​
    实例列表​
    显示当前沙箱应用的实例列表。如无可用沙箱实例,请单击 创建沙箱实例 创建。详细操作,请参见 创建沙箱实例。​
    ​
  • 变更管理​
  • ​
    功能模块​
    说明​
    变更详情​
    显示沙箱应用的变更信息。单击 变更 ID,可查看对应变更时间的具体变更内容。​
    版本回滚​
    单击指定版本右侧 操作 列下的 回滚,二次确认后,即可将应用回滚至该版本。​
    ​
  • 监控​
  • 可查看或配置沙箱应用的监控。更多操作和说明,请参见 监控与日志。​
  • 日志​
  • 可查看沙箱应用的日志。更多操作和说明,请参见 监控与日志。​
测试沙箱应用​
下文以公共镜像中类别为 Code 的 sandbox-fusion 镜像为例,测试沙箱应用。​
API 网关域名请求测试​
通过本地curl命令,调用 API 来测试云沙箱应用。可通过x-faas-insatnce-name指定实例请求。​
  • 将https://****.apigateway-cn-beijing.volceapi.com替换为您自己云沙箱函数的访问地址。​
  • 根据实际情况,替换data下的参数值。​
说明​
  • 若使用vefaas-public/sandbox-fusion,请参见开源文档 Sandbox Fusion 替换data参数值。​
  • 若使用他自定义的镜像,请根据实际情况填写data参数值。​
  • ​
    curl 'https://****.apigateway-cn-beijing.volceapi.com/run_code' \​
    -H 'accept: application/json, text/plain, */*' \​
    -H 'accept-language: zh-CN,zh;q=0.9' \​
    -H 'content-type: application/json' \​
    -H 'x-faas-instance-name: vefaas-ojxvvagw-ondm2cscas-d1eg8b1vnaumg4bf9190-sandbox' \​
    --data '{​
    "code": "ls",​
    "language": "bash",​
    "files":{}​
    }'​
    ​
Playground 测试​
  1. 在沙箱应用详情页面 基本信息 页签的 网关路由配置 区域,获取沙箱应用的 访问地址。​
  • ​​​
  1. 在 SandboxFusion 页面,单击 Playground 页签,选择 Sandbox 页面。​
  1. 在 Code 文本框中输入待运行代码段并选择对应编程语言,单击 Submit 提交代码运行请求。​
  • 等待运行完成后,可查看结果输出。​
  • ​​​
最近更新时间:2026.04.03 17:50:54
这个页面对您有帮助吗?
有用
有用
无用
无用