全部產品
Search

搜尋本產品

    Alibaba Cloud Model Studio：將API Key配置到環境變數

    文件中心

    Alibaba Cloud Model Studio：將API Key配置到環境變數

    更新時間：Dec 26, 2024

    建議您把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配置環境變數。

    系統屬性

    說明

    • 此方式配置的環境變數永久生效。

    • 修改系統內容變數需具備管理員權限。

    • 配置環境變數後不會立即影響已經開啟的命令視窗、IDE或其他正在啟動並執行應用程式。您需要重新啟動這些程式或者開啟新的命令列使環境變數生效。

    1. 在Windows系統案頭中按Win+Q鍵，在搜尋方塊中搜尋編輯系統內容變數，單擊開啟系統屬性介面。

    2. 單擊環境變數，然後在系統內容變數下單擊建立，變數名填入DASHSCOPE_API_KEY，變數值填入您的DashScope API Key。

      image

    3. 依次單擊三個介面的確定，關閉系統屬性配置頁面，完成環境變數配置。

    4. 開啟命令列終端，執行如下命令檢查環境變數是否生效。

      echo %DASHSCOPE_API_KEY%

    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？

    A：具體原因如下：

    • 情況一：沒有設定永久性環境變數。臨時環境變數只在當前終端會話有效，對於已經啟動的 IDE 或其他應用程式並不會生效。請參考本文中設定永久性環境變數的方法。

    • 情況二：沒有重啟IDE、命令列工具或應用。

      • 通常需要重啟IDE（如VS Code）或命令列工具，使其能夠載入最新的環境變數。

      • 如果在部署應用後設定了環境變數，可能需要重啟應用服務，讓應用能夠重新載入環境變數。

    • 情況三：需要在設定檔添加環境變數。如果您的應用是通過服務管理員（如systemd、supervisord）啟動的，可能需要在服務管理員的設定檔中添加環境變數。

    • 情況四：用了sudo命令。如果使用sudo python xx.py運行指令碼，可能會遺漏目前使用者環境變數，因為sudo預設不繼承所有環境變數。您可採用sudo -E python xx.py命令，其中的-E 參數確保環境變數被傳遞。如有許可權執行該指令碼，可以直接執行 python xx.py。