Alibaba Cloud Model Studio でモデルまたはアプリケーションを使用する前に、認証用の API キーを取得する必要があります。
注記このトピックでは、Model Studio の従量課金 API キーについて説明します。トークンプランまたはコーディングプランをご利用の場合は、対応する専用の API キー (sk-sp- で始まります) を使用してください。詳細については、「トークンプラン API キー」および「コーディングプラン API キー」をご参照ください。
API キーの作成
重要この手順は、Alibaba Cloud アカウントまたは 管理者 または API-Key の ページ権限 を持つRAM ユーザーが実行する必要があります。
中国 (北京)、シンガポール、およびその他のリージョン
-
Alibaba Cloud Model Studio コンソール に移動します。右上隅で、[China (Beijing)]、[Singapore]、日本 (東京)、[China (Hong Kong)]、または [Germany (Frankfurt)] などのリージョンを選択します。API Key ページに移動し、Create API Key をクリックします。
-
ダイアログボックスで次の設定を行い、確定 をクリックします。
- ワークスペース:デフォルトのワークスペースを選択することを推奨します。
- [Description] (オプション、最大 200 文字):API キーの目的を識別しやすくするための説明を入力します。
- 権限:全部 を選択することを推奨します。より詳細な制御が必要な場合は、カスタム を選択して、アクセス可能な IP アドレスとモデルを設定します。
-
キーが作成されると、完全な API キーと API ホスト (サービスエンドポイントアドレス) がダイアログボックスに表示されます。すぐにコピーまたはダウンロードして保存する必要があります。これらは機密情報として扱ってください。API キーを持つ者なら誰でも、あなたに代わってサービスリクエストを行うことができ、料金が発生する可能性があります。ダイアログボックスを閉じると、平文の API キーを再度表示またはコピーすることはできません。キーを紛失した場合は、リセットするか新しいキーを作成してください。
Alibaba Cloud アカウントは、すべてのワークスペース内の API キーを表示できます。RAM ユーザーは、自身が参加しているワークスペース内の API キーのみを表示できます。
米国 (バージニア) リージョン
-
Alibaba Cloud Model Studio コンソール に移動します。右上隅でリージョンを [US (Virginia)] に切り替えます。Dashboard タブで、左側メニューから [API Key] を選択します。API キー管理ページで、Create API Key をクリックします。
-
ダイアログボックスで次の情報を設定し、確定 をクリックします。
-
ワークスペース:デフォルトのワークスペースを選択することを推奨します。
-
[Description]:API キーの目的を識別しやすくするための説明を入力します。
-
権限:全部 を選択することを推奨します。より詳細な制御が必要な場合は、カスタム を選択して、アクセス可能な IP アドレスとモデルを設定します。
デフォルトでは、すべての IPv4 (
0.0.0.0/0) トラフィックが許可されます。 IPv6 は米国 (バージニア) リージョンではサポートされていません。 IP アドレスホワイトリストには、最大 20 個の IPv4 アドレスまたは CIDR ブロックを追加できます。 複数のエントリはコンマで区切ります。
-
-
キーが作成されると、完全な API キーがダイアログボックスに表示されます。すぐにコピーし、安全に保管してください。ダイアログボックスを閉じた後は、完全な API キーを再度表示することはできません。
-
API キーリストで、API キーの横にある
アイコンをクリックして、マスクされたキーをコピーします。Alibaba Cloud アカウントは、すべてのワークスペース内の API キーを表示できます。RAM ユーザーは、自身が参加しているワークスペース内の API キーのみを表示できます。
右上隅の [+ Create API key] ボタンをクリックして、新しい API キーを作成します。
他の所有者アカウントまたはワークスペースを使用する場合
チームでの共同作業やコスト配分が必要な場合は、以下を検討してください:
- ワークスペース:ワークスペースは、異なるプロジェクトやチームのリソースと権限を分離するために使用します。ユーザーグループが呼び出せるモデルを制御したり、モデル呼び出しのコストを配分したりするには、リストからサブワークスペースを作成または選択します。
詳細については、「API キーの権限」および「請求書の照会とコストの管理」をご参照ください。
環境変数としての API キーの設定
API キーを環境変数として設定することを推奨します。これにより、ソースコードにキーをハードコーディングすることを避け、偶発的な漏洩のリスクを低減できます。
Linux
永続的
現在のユーザーのすべての新しいセッションで API キーを利用できるようにするには、永続的な環境変数として設定します。
- 次のコマンドを実行して、環境変数の設定を
~/.bashrcファイルに追記します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc
または、~/.bashrc ファイルを手動で編集することもできます。
手動での変更
次のコマンドを実行して ~/.bashrc ファイルを開きます。
nano ~/.bashrc
設定ファイルに次の内容を追加します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
nano エディターで、Ctrl+X、Y、Enter の順にキーを押してファイルを保存し、閉じます。
- 次のコマンドを実行して、変更を適用します。
source ~/.bashrc
- 新しいターミナルウィンドウを開き、次のコマンドを実行して環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
一時的
現在のセッションでのみ環境変数を使用するには、一時的な環境変数として設定します。
- 次のコマンドを実行します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
- 次のコマンドを実行して、環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
macOS
永続的
現在のユーザーのすべての新しいセッションで API キーを利用できるようにするには、永続的な環境変数として設定します。
- ターミナルで次のコマンドを実行して、デフォルトのシェルタイプを確認します。
echo $SHELL
-
デフォルトのシェルタイプに基づいて進めます。
Zsh
- 次のコマンドを実行して、環境変数の設定を
~/.zshrcファイルに追記します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.zshrc別の方法として、
~/.zshrcファイルを手動で編集することもできます。手動での変更
次のコマンドを実行して、シェルの設定ファイルを開きます。
nano ~/.zshrc設定ファイルに次の内容を追加します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"nano エディターで、Ctrl+X、Y、Enter の順にキーを押してファイルを保存し、閉じます。
- 次のコマンドを実行して、変更を適用します。
source ~/.zshrc- 新しいターミナルウィンドウを開き、次のコマンドを実行して環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEYBash
- 次のコマンドを実行して、環境変数の設定を
~/.bash_profileファイルに追記します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bash_profileまたは、
~/.bash_profileファイルを手動で編集することもできます。手動での変更
次のコマンドを実行して、シェルの設定ファイルを開きます。
nano ~/.bash_profile設定ファイルに次の内容を追加します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"nano エディターで、Ctrl+X、Y、Enter の順にキーを押してファイルを保存し、閉じます。
- 次のコマンドを実行して、変更を適用します。
source ~/.bash_profile- 新しいターミナルウィンドウを開き、次のコマンドを実行して環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY - 次のコマンドを実行して、環境変数の設定を
一時的
現在のセッションでのみ環境変数を使用するには、一時的な環境変数として設定します。
次のコマンドは Zsh と Bash の両方に適用されます。
- 次のコマンドを実行します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"
- 次のコマンドを実行して、環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
Windows
Windows では、システムのプロパティ、コマンドプロンプト、または Windows PowerShell を使用して環境変数を設定できます。
システムのプロパティ
注記
- この方法で設定すると、環境変数は永続的になります。
- システム環境変数を変更するには、管理者権限が必要です。
- 環境変数の変更は、実行中のアプリケーション (コマンドプロンプトウィンドウや IDE を含む) には影響しません。変更を適用するには、これらのアプリケーションを再起動するか、新しいコマンドラインセッションを開く必要があります。
-
Windows デスクトップで
Win+Qを押し、検索ボックスで [システム環境変数の編集] を検索し、検索結果をクリックして [システムのプロパティ] ウィンドウを開きます。 -
システムのプロパティ ウィンドウで、環境変数をクリックします。システム環境変数 セクションで、作成をクリックします。Variable Nameに
DASHSCOPE_API_KEYを、変数値にお客様の DashScope API キーを入力します。 -
開いている 3 つのウィンドウすべてで OK をクリックして変更を保存し、ウィンドウを閉じます。
-
新しいコマンドプロンプトまたは Windows PowerShell ウィンドウを開き、適切なコマンドを実行して環境変数が設定されていることを確認します。
- コマンドプロンプトの場合:
echo %DASHSCOPE_API_KEY%
Microsoft Windows [Version 10.0.19045.5371]
(c) Microsoft Corporation. All rights reserved.
C:\Windows\system32>echo %DASHSCOPE_API_KEY%
sk-ee16697?fe4
C:\Windows\system32>
- Windows PowerShell の場合:
echo $env:DASHSCOPE_API_KEY
Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
Try the new cross-platform PowerShell https://aka.ms/pscore6
PS C:\Windows\system32> echo $env:DASHSCOPE_API_KEY
sk-ee166797fe40xxx
PS C:\Windows\system32>
コマンドプロンプト
永続的
現在のユーザーのすべての新しいセッションで API キー環境変数を利用できるようにするには、以下の手順に従います。
- コマンドプロンプトで次のコマンドを実行します。
REM YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます
setx DASHSCOPE_API_KEY "YOUR_DASHSCOPE_API_KEY"
- 新しいコマンドプロンプトウィンドウを開いて、変更を反映させます。
- 新しいコマンドプロンプトウィンドウで、次のコマンドを実行して環境変数が設定されていることを確認します。
echo %DASHSCOPE_API_KEY%
一時的
現在のセッションでのみ環境変数を使用するには、コマンドプロンプトで次のコマンドを実行します。
REM YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます
set DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY
同じセッションで次のコマンドを実行して、環境変数が設定されていることを確認できます。
echo %DASHSCOPE_API_KEY%
Windows PowerShell
永続的
現在のユーザーのすべての新しいセッションで API キー環境変数を利用できるようにするには、以下の手順に従います。
- Windows PowerShell で次のコマンドを実行します。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます
[Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "YOUR_DASHSCOPE_API_KEY", [EnvironmentVariableTarget]::User)
- 新しい Windows PowerShell ウィンドウを開いて、変更を反映させます。
- 新しい Windows PowerShell ウィンドウで、次のコマンドを実行して環境変数が設定されていることを確認します。
echo $env:DASHSCOPE_API_KEY
一時的
現在のセッションでのみ環境変数を使用したい場合は、PowerShell で次のコマンドを実行できます。
# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます
$env:DASHSCOPE_API_KEY = "YOUR_DASHSCOPE_API_KEY"
同じセッションで次のコマンドを実行して、環境変数が設定されていることを確認できます。
echo $env:DASHSCOPE_API_KEY
API キーの使用
-
方法 1:サードパーティツールからモデルを呼び出す
一般的なツールの設定ガイド:Chatbox、Cline、Claude Code、Dify、OpenClaw、Postman、Qwen Code。
-
方法 2:コードを使用してモデルを呼び出す
初めてコードを使用して Qwen API を呼び出す場合、漏洩リスクを低減するために、コードにハードコーディングするのではなく、API キーを環境変数として設定することを推奨します。
注記コードまたはサードパーティツールからモデルを呼び出す場合、API キーに加えてサービスエンドポイント (作成成功ダイアログに表示される API ホストであり、SDK または HTTP リクエストの base_url に相当します) を指定する必要があります。Model Studio は、OpenAI 互換と Anthropic 互換の両方のプロトコルインターフェイスを提供しています。base_url は 2 つのプロトコル間で異なり、リージョンによっても異なります。使用するプロトコルのドキュメントをご参照ください。
- OpenAI 互換プロトコル:OpenAI 互換 - Chat
- Anthropic 互換プロトコル:Anthropic 互換 Messages
API キーを公開しないでください。
API キーのセキュリティアップグレード
Model Studio では、セキュリティ強化のため、従量課金 API キーの生成および保存メカニズムがアップグレードされました (米国 (バージニア) リージョンを除く)。アップグレード前に作成された sk- で始まる API キーは、引き続き完全に機能し、影響を受けません。アップグレード後に作成されるすべての API キーは、sk-ws で始まります。
次の表は、アップグレード前後に作成された API キーの主な違いを説明したものです。
比較項目 | アップグレード前のキー | アップグレード後のキー |
|---|---|---|
キーのフォーマット |
|
|
平文での表示 | コンソールからいつでも完全な平文キーをコピーできます。 | 平文キーは作成時に一度だけ表示されます。ダイアログボックスを閉じた後は再表示できません。紛失した場合は、キーをリセットするか新規作成してください。 |
呼び出し機能 | モデルの呼び出しに通常どおり使用でき、機能への影響はありません。 | モデルの呼び出しに通常どおり使用でき、機能はアップグレード前のキーと同じです。 |
推奨されるアクション | セキュリティ向上のため、古いキーを新しいキーに置き換えることを推奨します。 | 作成後すぐにキーをコピーして保存し、安全に保管してください。 |
API による API キーの管理
コンソール操作に加えて、Alibaba Cloud Model Studio は OpenAPI 操作を提供しており、API キーの作成、照会、編集、削除、有効化、無効化、リセットをプログラムから実行できます。これにより、API キー管理を自動化されたワークフローに統合できます。
注記以下の操作を呼び出すには、Alibaba Cloud アカウントの AccessKey (API キー自体ではない) による署名認証と、対応する RAM 権限が必要です。各操作は OpenAPI 開発者ポータルでオンラインでデバッグするか、Alibaba Cloud SDK を介して呼び出すことができます。
操作 | 説明 |
|---|---|
API キーを作成します。 | |
指定された API キーの情報を照会します。 | |
API キーのリストを照会します。 | |
API キーの説明や権限設定などを編集します。 | |
API キーを削除します。この操作は元に戻せません。 | |
API キーを有効化します (米国 (バージニア) リージョンではサポートされていません)。 | |
API キーを無効化します。キーは保持され、いつでも再有効化できます (米国 (バージニア) リージョンではサポートされていません)。 | |
API キーをリセットします。新しいキー値が生成され、古いキーは直ちに無効になります (米国 (バージニア) リージョンではサポートされていません)。 |
API キーの権限
API キーの権限は、そのワークスペースによって完全に決定されます。同じワークスペース内のすべての API キーは同一の権限を持ちます。テキスト生成、テキストから画像、または音声合成モデルなど、異なるモデルに対して異なる API キーを作成する必要はありません。
- デフォルトワークスペースの API キー:すべての標準モデルと、デフォルトワークスペース内の任意のアプリケーションを呼び出すことができます。
- サブワークスペースの API キー:サブワークスペースに認可された標準モデルと、そのサブワークスペース内の任意のアプリケーションを呼び出すことができます。
注記新しい API キーを作成する または既存の API キーの Edit をクリックすると、権限 を カスタム に切り替えて、以下を設定できます:
- [IP アドレスホワイトリスト]:ホワイトリストに登録されたIPアドレスからのみ、APIキーを使用した呼び出しが可能です (IPv4 アドレスと CIDR ブロックをサポート。IPv6 は中国 (北京) リージョンでのみサポートされ、米国 (バージニア) リージョンは IPv4 のみをサポートします)。
- アクセス権限の範囲:この API キーがアクセスできる特定のモデルやアプリケーションを選択します。キーは選択されていないリソースを呼び出すことはできません。
API キーの有効期間
API キーに有効期限はありません。手動で削除するまで有効です。
サードパーティのアプリケーションやユーザーに一時的なアクセスを許可したり、機密データへのアクセスや削除などの高リスク操作を厳密に制御したりするには、一時的な API キー (有効期間 60 秒) を生成できます。これにより、長期APIキーが漏洩するリスクを低減できます。
エラーコード
モデルの呼び出しが失敗し、エラーメッセージが返された場合は、「エラーコード」を参照してトラブルシューティングを行ってください。
よくある質問
Q:1 つの Alibaba Cloud アカウントで作成できる API キーの数はいくつですか?A:シンガポール、中国 (北京)、中国 (香港)、日本 (東京)、ドイツ (フランクフルト) の各リージョンでは、Alibaba Cloud アカウントごとにリージョンあたり最大 50 個の API キーを作成できます。
米国 (バージニア) リージョンでは、Alibaba Cloud アカウントを含む各所有者アカウントが最大 20 個の API キーを作成できます。
Q:RAM ユーザーが作成した API キーは、そのユーザーが削除された後も有効ですか?A:いいえ。RAM コンソールで RAM ユーザーを無効化または削除すると、そのユーザーが作成したすべての API キーは無効になり、モデルの呼び出しには使用できなくなります。
Q: 私はechoコマンドを使用して環境変数が正しく設定されていることを確認しましたが、なぜ私のコードでは依然として API キーが見つからないと報告されるのでしょうか?
A:これは以下の理由で発生する可能性があります:
-
シナリオ 1:一時的な環境変数を設定した場合。一時変数は現在のターミナルセッション内でのみ有効であり、実行中の IDE や他のアプリケーションには影響しません。このトピックの手順を参照して、永続的な環境変数を設定してください。
-
シナリオ 2:IDE、コマンドラインツール、またはアプリケーションが再起動されていない場合。
- 新しい環境変数を読み込むには、IDE (VS Code など) やターミナルを再起動する必要があります。
- アプリケーションをデプロイした後に環境変数を設定した場合、環境変数を再読み込みするためにアプリケーションサービスを再起動する必要があります。
-
シナリオ 3:サービス設定ファイルに変数が欠落している場合。アプリケーションが systemd や supervisord などのサービスマネージャーによって起動される場合、サービスマネージャーの設定ファイルに環境変数を追加する必要があるかもしれません。
-
シナリオ 4: 使用
sudoコマンド。sudo python xx.pyを使用してスクリプトを実行すると、現在のユーザーの環境変数が継承されない場合があります。これは、sudoがデフォルトですべての環境変数を継承するわけではないためです。-Eパラメーターを使用して環境変数が渡されるようにするsudo -E python xx.pyコマンドを使用できます。スクリプトを実行する権限がある場合は、python xx.pyを直接実行できます。