AI 助理
备案控制台
文档
输入文档关键字查找
首页 大模型服务平台百炼 开发参考 配置API Key到环境变量

将API Key配置到环境变量

更新时间：
产品详情
我的收藏

建议您把API Key配置到环境变量，从而避免在代码里显式地配置API Key，降低泄漏风险。

操作步骤

Linux系统

添加永久性环境变量

如果您希望API Key环境变量在当前用户的所有新会话中生效，可以添加永久性环境变量。

  1. 执行以下命令来将环境变量设置追加到~/.bashrc 文件中。

    # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc

    也可以手动修改~/.bashrc 文件。

    手动修改

    执行以下命令，打开~/.bashrc 文件。

    nano ~/.bashrc

    在配置文件中添加以下内容。

    # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

    在nano编辑器中，按Ctrl + X，接着按Y，再按Enter以保存并关闭文件。

  2. 执行以下命令，使变更生效。

    source ~/.bashrc

  3. 重新打开一个终端窗口，运行以下命令检查环境变量是否生效。

    echo $DASHSCOPE_API_KEY

添加临时性环境变量

如果您仅希望在当前会话中使用该环境变量，可以添加临时性环境变量。

  1. 执行以下命令。

    # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

  2. 执行以下命令，验证该环境变量是否生效。

    echo $DASHSCOPE_API_KEY

macOS系统

添加永久性环境变量

如果您希望API Key环境变量在当前用户的所有新会话中生效，可以添加永久性环境变量。

  1. 在终端中执行以下命令，查看默认shell类型。

    echo $SHELL

  2. 根据默认shell类型进行操作。

    Zsh

    1. 执行以下命令来将环境变量设置追加到 ~/.zshrc 文件中。

      # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.zshrc

      也可以手动修改~/.zshrc 文件。

      手动修改

      执行以下命令，打开shell配置文件。

      nano ~/.zshrc

      在配置文件中添加以下内容。

      # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

      在nano编辑器中，按Ctrl + X，接着按Y，再按Enter以保存并关闭文件。

    2. 执行以下命令，使变更生效。

      source ~/.zshrc

    3. 重新打开一个终端窗口，运行以下命令检查环境变量是否生效。

      echo $DASHSCOPE_API_KEY

    Bash

    1. 执行以下命令来将环境变量设置追加到 ~/.bash_profile 文件中。

      # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bash_profile

      也可以手动修改~/.bash_profile 文件。

      手动修改

      执行以下命令，打开shell配置文件。

      nano ~/.bash_profile

      在配置文件中添加以下内容。

      # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

      在nano编辑器中，按Ctrl + X，接着按Y，再按Enter以保存并关闭文件。

    2. 执行以下命令，使变更生效。

      source ~/.bash_profile

    3. 重新打开一个终端窗口，运行以下命令检查环境变量是否生效。

      echo $DASHSCOPE_API_KEY

添加临时性环境变量

如果您仅希望在当前会话中使用该环境变量，可以添加临时性环境变量。

  1. 执行以下命令。

    # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

  2. 执行以下命令，验证该环境变量是否生效。

    echo $DASHSCOPE_API_KEY

Windows系统

在Windows系统中，您可以使用CMD或PowerShell运行命令。

CMD

添加永久性环境变量

如果您希望API Key环境变量在当前用户的所有新会话中生效，可以按如下操作。

  1. 在CMD中运行以下命令。

    # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
setx DASHSCOPE_API_KEY "YOUR_DASHSCOPE_API_KEY"

  2. 打开一个新的CMD窗口。

  3. 在新的CMD窗口运行以下命令，检查环境变量是否生效。

    echo %DASHSCOPE_API_KEY%

添加临时性环境变量

如果您仅希望在当前会话中使用该环境变量，可以在CMD中运行以下命令。

# 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
set DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY

您可以在当前会话运行以下命令检查环境变量是否生效。

echo %DASHSCOPE_API_KEY%

PowerShell

添加永久性环境变量

如果您希望API Key环境变量在当前用户的所有新会话中生效，可以按如下操作。

  1. 在PowerShell中运行以下命令。

    # 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
[Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "YOUR_DASHSCOPE_API_KEY", [EnvironmentVariableTarget]::User)

  2. 打开一个新的PowerShell窗口。

  3. 在新的PowerShell窗口运行以下命令，检查环境变量是否生效。

    echo $env:DASHSCOPE_API_KEY

添加临时性环境变量

如果您仅希望在当前会话中使用该环境变量，可以在PowerShell中运行以下命令。

# 用您的 DashScope API Key 代替 YOUR_DASHSCOPE_API_KEY
$env:DASHSCOPE_API_KEY = "YOUR_DASHSCOPE_API_KEY"

您可以在当前会话运行以下命令检查环境变量是否生效。

echo $env:DASHSCOPE_API_KEY

常见问题

Q：用echo命令确认环境变量设置成功了，为什么运行代码还是提示找不到API Key？

  • 情况一：通常需要重启IDE（如VS Code）或命令行工具，使其能够加载最新的环境变量。

  • 情况二：如果在部署应用后设置了环境变量，可能需要重启应用服务，让应用能够重新加载环境变量。

  • 情况三：如果您的应用是通过服务管理器（如systemd、supervisord）启动的，可能需要在服务管理器的配置文件中添加环境变量。

  • 情况四：如果使用sudo python xx.py运行脚本，可能会遗漏当前用户环境变量，因为sudo默认不继承所有环境变量。您可采用sudo -E python xx.py命令，其中的-E 参数确保环境变量被传递。如有权限执行该脚本，可以直接执行 python xx.py。

上一篇：获取API Key下一篇：安装SDK
文档推荐