配置函数的环境变量

操作场景

为函数配置环境变量，可以在不修改代码的情况下，将动态参数传递到函数，调整函数的执行行为。

环境变量在函数中适用于以下场景：

• 区分多环境：相同的函数逻辑，可根据部署环境的不同，配置不同的环境变量以区分。例如，通过环境变量给测试和开发环境配置不同的数据库。
• 加密配置：函数中访问其他服务的认证信息，如账号和密码，可通过配置加密环境变量在代码中动态获取，确保敏感数据的安全。
• 动态配置：函数逻辑中需要动态调整的配置，如查询周期、超时时间，可提取为环境变量，以避免业务每次变化都需要修改代码。

约束与限制

设置环境变量时，FunctionGraph会明文展示所有输入信息，请不要输入敏感信息（如账户密码等），以防止信息泄露。

配置环境变量

1. 登录函数工作流控制台函数工作流控制台，在左侧的导航栏选择“函数 > 函数列表”。
2. 单击函数的名称，进入函数详情页。
3. 在“设置”页签下选择“环境变量”，单击“编辑环境变量”。
   图1 添加环境变量
   
4. 在“编辑环境变量”弹窗中单击“添加环境变量”，配置环境变量信息。

   使用表单编辑

   • 使用表单编辑环境变量的参数说明请参考表1。

     表1 环境变量配置参数说明

     参数	说明
     键	环境变量的键（key）。 取值范围：以大小写字母开头，可包含大小写字母、数字、下划线（_）、中划线（-）和点（.），键和值的总长度不超过4096个字符。 系统预置了部分环境变量配置，您无法配置和预置值同名的环境变量，预置的环境变量请参见环境变量预置值。
     值	环境变量的值（value）。 取值范围：键和值的总长度不超过4096个字符。
     加密参数	开启加密参数后，环境变量的值将以“*”号加密显示，参数传输过程中键值也处于加密状态。 已开启加密并保存的环境变量值，取消加密后将重置为空。 图2 使用表单编辑环境变量
     传输中加密	此参数仅“拉美-圣保罗一”区域支持配置。 注意： 数据加密服务DEW将按需收取费用，详情请参见数据加密服务计费说明。 单击“加密”按钮为环境变量加密，支持以下加密类型： AES加密：使用AES加密环境变量，无需手动创建密钥。 KMS加密：支持选择已创建的KMS密钥加密函数环境变量。 前提条件 使用KMS加密环境变量前，需向函数授予调用Decrypt操作的权限，请参考JSON视图配置自定义策略前往IAM控制台将“委托权限策略”添加至函数委托中，并参考配置函数委托为该函数配置委托权限。 选择KMS密钥 请选择已启用的自主管理型密钥，如无可用密钥，可参考创建用户主密钥创建自定义密钥进行创建。 解密环境变量 使用KMS加密环境变量后，需在函数代码中添加“解密密钥代码段”用以解密环境变量，请注意将代码段中的 {endpoint} 替换为对应区域的终端节点。 图3 传输中加密 开启加密参数后，环境变量的值将以“*”号加密显示，参数传输过程中键值也处于加密状态。 已开启加密并保存的环境变量值，取消加密后将重置为空。

   使用JSON格式编辑

   • 使用JSON格式编辑环境变量的示例说明。

     {
         "obs_output_bucket": "obs_image"
     }

     如需使用AES加密环境变量，需为键添加前缀“_encrypt_”。

     {
         "_encrypt_obs_output_bucket": "obs_image"
     }

5. （可选，仅“拉美-圣保罗一”区域支持配置）选择为环境变量是否使用“静态加密配置”。
   如选择使用KMS静态加密，请先将“委托权限策略”添加至该函数的委托中。支持选择以下两种KMS静态加密：

   • （默认）functiongraph/default：函数会在DEW服务中自动创建默认密钥，您无需手动创建。
   • 使用用户主密钥：选择已创建的用户主密钥加密函数代码。创建用户主密钥可参考创建自定义密钥。
6. 配置完成后，单击“确定”保存环境变量。

   环境变量配置完成后，即可在函数中使用环境变量，具体应用示例可参见环境变量应用示例。

环境变量预置值

FunctionGraph预置的环境变量如表2所示。

环境变量应用示例

使用环境变量设置以下信息：安装文件的目录、存储输出的位置、存储连接和日志记录设置等。这些设置与应用程序逻辑解耦，在需要变更设置时，无需更新函数代码。

1. 设置环境变量obs_output_bucket，用于灵活设置存储输出图片的OBS桶。
   图4 环境变量
   
2. 在函数代码中使用环境变量。

   在如下函数代码片段中，参数“obs_output_bucket”为图片处理后存储地址。

   

   • 非HTTP函数使用context.getUserData('xxx')方式获取环境变量。
   • HTTP函数使用系统方法获取环境变量，例如Python函数使用os.Environ['xx']；Node.js函数使用process.env.xx，Node.js获取加密环境变量使用process.env.RUNTIME_USERDATA。
   • Python语言示例

     def handler(event, context):
         srcBucket, srcObjName = getObsObjInfo4OBSTrigger(event)
         obs_address = context.getUserData('obs_address')
         outputBucket = context.getUserData('obs_output_bucket')
         if obs_address is None:
             obs_address = '{obs_address_ip}'
         if outputBucket is None:
             outputBucket = 'casebucket-out'
                 
         ak = context.getSecurityAccessKey()
         sk = context.getSecuritySecretKey()
         st = context.getSecurityToken()
     
         # download file uploaded by user from obs 
         # TODO: Replace with actual implementation
         GetObject(obs_address, srcBucket, srcObjName, ak, sk, st)
     
         outFile = watermark_image(srcObjName)
         
         # 将转换后的文件上传到新的obs桶中
         # TODO: Replace with actual implementation
         PostObject(obs_address, outputBucket, outFile, ak, sk, st)
     
         return 'OK'
     

   • NodeJS语言示例

     exports.handler = async (event, context) => {
         let bucket = context.getUserData('obs_output_bucket');
         console.log(bucket);
         const output =
         {
             'statusCode': 200,
             'headers':
             {
                 'Content-Type': 'application/json'
             },
             'isBase64Encoded': false,
             'body': JSON.stringify(event),
         }
         return output;
     }

相关文档

• 除使用控制台外，函数工作流支持通过API的方式管理函数的生命周期，详情请参见函数生命周期管理API。
• 函数环境变量相关常见问题详情请参见配置函数常见问题。