Alibaba Cloud Model Studio (Model Studio) でモデルまたはアプリケーションを使用する前に、認証用の API キーを取得する必要があります。
このトピックでは、Model Studio の従量課金 API キーについて説明します。 トークンプランまたはコーディングプランをご利用の場合は、対応する専用 API キー (sk-sp- で始まる) を使用してください。 詳細については、「トークンプラン API キー」および「コーディングプラン API キー」をご参照ください。
APIキーの作成
この手順は、Alibaba Cloud アカウント または 管理者 または API-Key ページ権限 を持つ RAM ユーザー が実行する必要があります。
中国 (北京)、シンガポール、およびその他のリージョン
-
Model Studio コンソールに移動します。右上隅で、China (Beijing)、Singapore、[Japan (Tokyo)]、China (Hong Kong)、またはGermany (Frankfurt)などのリージョンを選択します。APIキーページに移動し、Create API Key をクリックします。
-
ダイアログボックスで、次の設定を行い、確定 をクリックします。
-
ワークスペース:デフォルトのワークスペースを選択することを推奨します。
-
[Permission]:全部 を選択することを推奨します。より詳細な制御が必要な場合は、カスタム を選択して、アクセス可能な IP アドレスとモデルを設定します。
-
-
キーが作成されると、完全な API キーがダイアログボックスに表示されます。直ちにコピーまたはダウンロードして保存する必要があります。このキーは機密情報として扱ってください。API キーを持つ第三者は誰でも、あなたに代わってサービスリクエストを行うことができ、料金が発生する可能性があります。ダイアログボックスを閉じると、プレーンテキストの API キーを再度表示したりコピーしたりすることはできません。キーを紛失した場合は、リセットするか、新しいキーを作成してください。
Alibaba Cloud アカウントは、すべてのワークスペース内の API キーを表示できます。RAM ユーザーは、自身が参加しているワークスペース内の API キーのみを表示できます。
APIキー管理ページで、右上の[+ Create API key] をクリックして別のキーを作成します。既存の API キーについては、[Actions] 列で[Disable]、[Edit]、または[Delete] を実行できます。
US (Virginia) リージョン
-
Model Studio コンソールに移動します。右上隅で、リージョンをUS (Virginia) に切り替えます。Dashboard タブで、[API Key] をナビゲーションペインから選択します。API キー管理ページで、Create API Key をクリックします。
-
ダイアログボックスで、次の情報を設定し、確定 をクリックします。
-
ワークスペース:デフォルトのワークスペースを選択することを推奨します。
-
[Description]:API キーの目的を識別しやすくするために、説明を入力します。
-
-
キーが作成されると、完全な API キーがダイアログボックスに表示されます。直ちにコピーし、安全に保管してください。ダイアログボックスを閉じると、完全な API キーを再度表示することはできません。
-
API キーリストで、API キーの横にある
アイコンをクリックして、マスクされたキーをコピーします。Alibaba Cloud アカウントは、すべてのワークスペース内の API キーを表示できます。RAM ユーザーは、自身が参加しているワークスペース内の API キーのみを表示できます。
右上の[+ Create API key] ボタンをクリックして、新しい API キーを作成します。
APIキーの環境変数としての設定
API キーを環境変数として設定することを推奨します。これにより、ソースコードにキーをハードコーディングするのを避け、意図しない漏洩のリスクを低減できます。
Linux
永続的な設定
現在のユーザーのすべての新しいセッションで API キーを利用できるようにするには、永続的な環境変数として設定します。
-
次のコマンドを実行して、環境変数の設定を
~/.bashrcファイルに追記します。# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrcまたは、
~/.bashrcファイルを手動で編集することもできます。 -
次のコマンドを実行して変更を適用します。
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ファイルを手動で編集することもできます。 -
次のコマンドを実行して変更を適用します。
source ~/.zshrc -
新しいターミナルウィンドウを開き、次のコマンドを実行して環境変数が設定されていることを確認します。
echo $DASHSCOPE_API_KEY
Bash
-
次のコマンドを実行して、環境変数の設定を
~/.bash_profileファイルに追記します。# YOUR_DASHSCOPE_API_KEY をお使いの DashScope API キーに置き換えます echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bash_profile別の方法として、
~/.bash_profileファイルを手動で編集できます。 -
次のコマンドを実行して変更を適用します。
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_KEYWindows 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 compatible - Chat
-
Anthropic 互換プロトコル:Anthropic-compatible Messages
API キーを漏洩させないでください。
APIキーのセキュリティアップグレード
Model Studio は、セキュリティ強化のため、従量課金 API キーの生成およびストレージメカニズムをアップグレードしました (米国 (バージニア) リージョンを除く)。アップグレード前に作成された sk- で始まる API キーは、引き続き完全に機能し、影響はありません。アップグレード後に作成されるすべての API キーは sk-ws で始まります。
次の表に、アップグレード前とアップグレード後に作成された API キーの主な違いを示します。
|
比較項目 |
アップグレード前のキー |
アップグレード後のキー |
|
キーの形式 |
|
|
|
プレーンテキストの表示 |
コンソールからいつでも完全なプレーンテキストのキーをコピーできます。 |
プレーンテキストのキーは作成時に一度だけ表示されます。ダイアログボックスを閉じた後は、再度表示することはできません。紛失した場合は、キーをリセットするか、新しいキーを作成してください。 |
|
呼び出し機能 |
従来どおりモデルの呼び出しに使用でき、機能に影響はありません。 |
従来どおりモデルの呼び出しに使用でき、機能はアップグレード前のキーと同じです。 |
|
推奨アクション |
セキュリティ向上のため、新しいキーを作成して古いキーを置き換えることを推奨します。 |
作成後、直ちにキーをコピーして保存し、安全に保管してください。 |
APIによるAPIキーの管理
コンソール操作に加えて、Model Studio は OpenAPI を提供しており、API キーの作成、照会、編集、削除、有効化、無効化、リセットをプログラムから実行できます。これにより、API キー管理を自動化されたワークフローに統合できます。
以下の API を呼び出すには、Alibaba Cloud アカウントの AccessKey (API キー自体ではありません) による署名認証と、対応する RAM 権限が必要です。各 API は OpenAPI デベロッパーポータルでオンラインでデバッグするか、Alibaba Cloud SDK を使用して呼び出すことができます。
|
操作 |
説明 |
|
API キーを作成します。 |
|
|
指定された API キーの情報を照会します。 |
|
|
API キーのリストを照会します。 |
|
|
API キーの説明や権限設定などを編集します。 |
|
|
API キーを削除します。この操作は元に戻せません。 |
|
|
API キーを有効化します (US (Virginia) リージョンではサポートされていません)。 |
|
|
API キーを無効化します。キーは保持され、いつでも再有効化できます (US (Virginia) リージョンではサポートされていません)。 |
|
|
API キーをリセットします。新しいキー値が生成され、古いキーは直ちに無効になります (US (Virginia) リージョンではサポートされていません)。 |
APIキーの権限
API キーの権限は、そのワークスペースによって決まります。同じワークスペース内のすべての API キーは、同じ権限を持ちます。テキスト生成、画像生成、音声合成などのモデルごとに異なる API キーを作成する必要はありません。
-
デフォルトワークスペースの API キー:すべての標準モデルと、デフォルトワークスペース内の任意のアプリケーションを呼び出すことができます。
-
サブワークスペースの API キー:サブワークスペースに認可された標準モデルと、そのサブワークスペース内の任意のアプリケーションを呼び出すことができます。
新しい API キーを作成する をクリックするか、既存の API キーでEdit をクリックした際に、権限 をカスタム に切り替えることで、以下を設定できます。
以下の設定は、US (Virginia) リージョンではサポートされていません。
-
[IP Address Whitelist]:ホワイトリストに登録された IP アドレスからのみ、API キーを使用した呼び出しを許可します (IPv4、IPv6、および CIDR ブロックに対応しています)。
-
アクセス権限の範囲:この API キーがアクセスできる特定のモデルまたはアプリケーションを選択します。選択されていないリソースは、このキーで呼び出すことはできません。
APIキーの有効期間
API キーに有効期限はありません。手動で削除するまで有効です。
サードパーティアプリケーションやユーザーに一時的なアクセスを許可する場合、または機密データのアクセスや削除などのリスクの高い操作を厳密に制御する必要がある場合は、一時的な API キー (有効期間 60 秒) を生成できます。これにより、長期間有効な API キーの漏洩を避け、リスクを低減できます。
エラーコード
モデルの呼び出しが失敗し、エラーメッセージが返された場合は、「エラーコード」を参照してトラブルシューティングを行ってください。
よくある質問
Q:1つの Alibaba Cloud アカウントで作成できる API キーはいくつですか?
A:Singapore、China (Beijing)、China (Hong Kong)、Japan (Tokyo)、Germany (Frankfurt)の各リージョンで、Alibaba Cloud アカウントごとにそれぞれ最大 50 個の API キーを作成できます。
US (Virginia) リージョンでは、Alibaba Cloud アカウントを含む各オーナーアカウントで最大 20 個の API キーを作成できます。
Q:RAM ユーザーが作成した API キーは、そのユーザーが削除された後も有効ですか?
A:いいえ。RAM ユーザーを無効化または削除すると、そのユーザーが作成したすべての API キーは無効になり、モデルの呼び出しに使用できなくなります。
Q: 実行した echo コマンドで環境変数が正しく設定されていることを確認しましたが、なぜコードで 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を直接実行できます。
