Alibaba Cloud Model Studio で API キーを環境変数として設定する - Alibaba Cloud Model Studio

Alibaba Cloud Model Studio SDK を使用するときに明示的に API キーを指定することを避け、API 漏洩のリスクを軽減するために、API キーを環境変数として設定することをお勧めします。このトピックでは、API キーを環境変数として設定する方法について説明します。

前提条件

Model Studio をアクティブ化し、API キーを取得済みであること。

手順

Linux

永続的な環境変数

現在のユーザーが新しいセッションで使用する永続的な環境変数として API キーを設定するには、永続的な環境変数として設定します。

次のコマンドを実行して、~/.bashrc ファイルに環境変数を追加します。
```
# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc
```
~/.bashrc ファイルを手動で編集することもできます。
手動で編集する
次のコマンドを実行して、~/.bashrc ファイルを開きます。
```
nano ~/.bashrc
```
ファイルに次の内容を追加します。
```
# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
```
nano エディターで、Ctrl + X を押してから Y を押します。Enter キーを押してファイルを保存して閉じます。
変更を有効にするには、次のコマンドを実行します。
```
source ~/.bashrc
```
セッションを作成し、次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
```
echo $DASHSCOPE_API_KEY
```

一時的な環境変数

現在のセッションに対してのみ API キーを一時的な環境変数として使用するには、一時的な環境変数として設定します。

次のコマンドを実行します。

# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
```
echo $DASHSCOPE_API_KEY
```

macOS

永続的な環境変数

現在のユーザーが新しいセッションで使用する永続的な環境変数として API キーを設定するには、永続的な環境変数として設定します。

次のコマンドを実行して、デフォルトのシェルタイプを確認します。
```
echo $SHELL
```
シェルタイプに基づいて、次の操作を実行します。
Zsh
1. 次のコマンドを実行して、~/.zshrc ファイルに環境変数を追加します。
```
# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.zshrc
```
  ~/.zshrc ファイルを手動で編集することもできます。
  手動で編集する
  次のコマンドを実行して、構成ファイルを開きます。
  nano ~/.zshrc
  ファイルに次の内容を追加します。
  # YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。 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 ファイルに環境変数を追加します。
```
# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bash_profile
```
  ~/.bash_profile ファイルを手動で編集することもできます。
  手動で編集する
  次のコマンドを実行して、ファイルを開きます。
  nano ~/.bash_profile
  ファイルに次の内容を追加します。
  # YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。 export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
  nano エディターで、Ctrl + X を押してから Y を押します。Enter キーを押してファイルを保存して閉じます。
2. 変更を有効にするには、次のコマンドを実行します。
```
source ~/.bash_profile
```
3. セッションを作成し、次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
```
echo $DASHSCOPE_API_KEY
```

一時的な環境変数

現在のセッションに対してのみ API キーを一時的な環境変数として使用するには、一時的な環境変数として設定します。

次のコマンドは、Zsh と Bash でのみ機能します。

次のコマンドを実行します。

# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
```
echo $DASHSCOPE_API_KEY
```

Windows

Windows では、システムのプロパティ、コマンドライン、または PowerShell を使用して環境変数を設定できます。

システムのプロパティ

説明

この方法で構成された環境変数は永続的に有効です。
システム環境変数の変更には、管理者権限が必要です。
環境変数を構成した後、既に開いているコマンドウィンドウ、IDE、またはその他の実行中のアプリケーションにはすぐに影響しません。環境変数を有効にするには、これらのプログラムを再起動するか、新しいコマンドラインを開く必要があります。

デスクトップで Win + Q を押します。検索ボックスに「システム環境変数の編集」と入力し、クリックして [システムのプロパティ] ウィンドウを開きます。
[システムのプロパティ] ウィンドウで、[環境変数] をクリックします。[システム環境変数] セクションで、[新規] をクリックし、変数名として DASHSCOPE_API_KEY を、変数値として 実際の API キー を入力します。
3 つのダイアログボックスすべてで [OK] をクリックします。
CMD または Windows PowerShell を開き、次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
- CMD:
```
echo %DASHSCOPE_API_KEY%
```
- Windows PowerShell:
```
echo $env:DASHSCOPE_API_KEY
```

CMD

永続的な環境変数

現在のユーザーが新しいセッションで使用する永続的な環境変数として API キーを設定するには、永続的な環境変数として設定します。

次のコマンドを実行します。

# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
setx DASHSCOPE_API_KEY "YOUR_DASHSCOPE_API_KEY"

新しいセッションを作成します。
次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
```
echo %DASHSCOPE_API_KEY%
```

一時的な環境変数

現在のセッションに対してのみ API キーを一時的な環境変数として使用するには、一時的な環境変数として設定します。

次のコマンドを実行します。

# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
set DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

現在のセッションで次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
```
echo %DASHSCOPE_API_KEY%
```

PowerShell

永続的な環境変数

現在のユーザーが新しいセッションで使用する永続的な環境変数として API キーを設定するには、永続的な環境変数として設定します。

次のコマンドを実行します。

# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
[Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "YOUR_DASHSCOPE_API_KEY", [EnvironmentVariableTarget]::User)

セッションを作成します。
次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
```
echo $env:DASHSCOPE_API_KEY
```

一時的な環境変数

現在のセッションに対してのみ API キーを一時的な環境変数として使用するには、一時的な環境変数として設定します。

次のコマンドを実行します。

# YOUR_DASHSCOPE_API_KEY を実際の API キーに置き換えます。
$env:DASHSCOPE_API_KEY = "YOUR_DASHSCOPE_API_KEY"

現在のセッションで次のコマンドを実行して、環境変数が有効になっているかどうかを確認します。
```
echo $env:DASHSCOPE_API_KEY
```

FAQ

Q: echo コマンドを実行して環境変数を確認しました。しかし、コードを実行すると、API キーが見つからない、または無効な API キーであると表示されます。

A: 原因は次のとおりです。

シナリオ 1：設定した環境変数が永続的ではありません。一時的な環境変数は、現在のターミナルセッションでのみ有効であり、既に開いている IDE や他のアプリケーションでは有効になりません。永続的な環境変数を設定する方法については、このトピックの方法を参照してください。
シナリオ 2：IDE、コマンドラインツール、またはアプリケーションを再起動していません。
- 通常、最新の環境変数をロードするには、IDE（VS Code など）またはコマンドラインツールを再起動する必要があります。
- アプリケーションのデプロイ後に環境変数を設定した場合は、環境変数を再ロードするためにアプリケーションサービスを再起動する必要がある場合があります。
シナリオ 3：構成ファイルに環境変数を追加する必要があります。アプリケーションがサービスマネージャー（systemd や supervisord など）によって起動される場合は、サービスマネージャーの構成ファイルに環境変数を追加する必要がある場合があります。
シナリオ 4：sudo コマンドを使用しました。sudo python xx.py を使用してスクリプトを実行すると、sudo はデフォルトですべての環境変数を継承しないため、現在のユーザーの環境変数が失われる可能性があります。sudo -E python xx.py コマンドを使用できます。ここで、-E オプションは、環境変数が渡されるようにします。スクリプトを実行する権限がある場合は、python xx.py を使用して直接実行できます。
シナリオ 5：Model Studio のベース URL を構成する必要がある場合があります。次のいずれかの方法を使用します。
- コードにベース URL を追加します。
```
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
```
- ベース URL を環境変数として設定します。
```
DASHSCOPE_HTTP_BASE_URL='https://dashscope-intl.aliyuncs.com/api/v1'
```