文档

通过环境变量配置API-KEY

更新时间:

您可以使用配置环境变量的方法,避免在调用DashScope的SDK时显式地配置API-KEY,从而降低泄漏风险。

环境变量是操作系统中用于存储有关系统环境的信息的变量。您可以通过环境变量来配置API-KEY,这样即使您的代码库被公开,API-KEY也不会泄漏。您可以根据您的操作系统与使用场景来确定添加API-KEY到环境变量中的方法。

Linux系统

当您使用Linux系统(如Ubuntu、CentOS等)中的命令行添加DashScope的API-KEY为环境变量时,可以选择在当前会话添加临时性环境变量,或对当前用户添加永久性环境变量。

  • 添加临时性环境变量

    如果您仅想在当前会话中添加并使用临时性环境变量,您可以运行以下命令:

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

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

    echo $DASHSCOPE_API_KEY
  • 对当前用户添加永久性环境变量

    如果您想对当前用户添加永久性环境变量,使得在该用户的新会话中也可以使用该环境变量,您可以把以下命令语句复制并添加到~/.bashrc文件中:

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

    或直接运行以下命令将上述命令语句添加到~/.bashrc中:

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

    添加完成后,您可以运行以下命令使得环境变量生效:

    source ~/.bashrc

    您可以新建立一个会话,运行以下命令检查环境变量是否生效:

    echo $DASHSCOPE_API_KEY

macOS系统

当您使用macOS系统中的命令行添加DashScope的API-KEY为环境变量时,可以选择在当前会话添加临时性环境变量,或对当前用户添加永久性环境变量。

  • 添加临时性环境变量

    如果您仅想在当前会话中添加并使用临时性环境变量,您可以运行以下命令:

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

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

    echo $DASHSCOPE_API_KEY
  • 对当前用户添加永久性环境变量

    如果您想对当前用户添加永久性环境变量,使得在该用户的新会话中也可以使用该环境变量,您可以根据您使用的Shell类型把以下命令复制并添加到~/.zshrc或~/.bash_profile文件中。

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

    或直接运行以下命令将上述命令语句添加到~/.zshrc或~/.bash_profile中:

    # 用您的 DashScope API-KEY 代替 YOUR_DASHSCOPE_API_KEY
    ## 如果您的Shell类型是Zsh,运行以下命令
    echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.zshrc
    
    ## 如果您的Shell类型是Bash,运行以下命令
    echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bash_profile

    添加完成后,您可以根据您使用的Shell类型运行以下命令使得环境变量生效:

    # 如果您的Shell类型是Zsh,运行以下命令
    source ~/.zshrc
    
    # 如果您的Shell类型是Bash,运行以下命令
    source ~/.bash_profile

    您可以新建立一个会话,运行以下命令检查环境变量是否生效:

    echo $DASHSCOPE_API_KEY

Windows系统

在Windows系统中,您可以使用CMD或PowerShell(推荐)运行命令。

CMD

当您使用CMD中的命令行添加DashScope的API-KEY为环境变量时,可以选择在当前会话添加临时性环境变量,或对当前用户添加永久性环境变量。

  • 添加临时性环境变量

    如果您仅想在当前会话中添加并使用临时性环境变量,您可以运行以下命令:

    # 用您的 DashScope API-KEY 代替 YOUR_DASHSCOPE_API_KEY
    set DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

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

    echo %DASHSCOPE_API_KEY%
  • 对当前用户添加永久性环境变量

    当您在CMD中需要为当前用户添加永久性环境变量时,您可以运行以下命令:

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

    您可以新建立一个会话,运行以下命令检查环境变量是否生效:

    echo %DASHSCOPE_API_KEY%

PowerShell

当您使用PowerShell中的命令行添加DashScope的API-KEY为环境变量时,可以选择在当前会话添加临时性环境变量,或对当前用户添加永久性环境变量。

  • 添加临时性环境变量

    如果您仅想在当前会话中添加并使用临时性环境变量,您可以运行以下命令:

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

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

    echo %DASHSCOPE_API_KEY%
  • 对当前用户添加永久性环境变量

    如果您在PowerShell中需要为当前用户添加永久性环境变量,您可以运行以下命令:

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

    您可以新建立一个会话,运行以下命令检查环境变量是否生效:

    echo %DASHSCOPE_API_KEY%
  • 本页导读 (0)
文档反馈