API-KEY的獲取與配置
如果您需要調(diào)用通義千問或其它DashScope支持的模型API，需要首先開通DashScope。通過本文檔您可以了解到獲取與配置DashScopeAPI-KEY的方法。
靈積（DashScope）即將升級，統(tǒng)一合入百煉。建議您通過百煉使用阿里云的大模型服務(wù)，具體請參見首次調(diào)用通義千問API。
開通DashScope
您需要在開通DashScope后，才可以獲得API-KEY。開通DashScope請參考以下步驟：
訪問DashScope管理控制臺：前往控制臺。
在控制臺“總覽”頁下，單擊去開通。
閱讀服務(wù)協(xié)議，確認無誤后單擊立即開通。
獲取API-KEY
您可以按照以下步驟獲取DashScope的API-KEY。
訪問DashScope管理控制臺API-KEY管理頁面：前往API-KEY管理，單擊創(chuàng)建新的API-KEY。
系統(tǒng)創(chuàng)建生成API-KEY，并在彈出的對話框中展示，您可以單擊復(fù)制按鈕將API-KEY的內(nèi)容復(fù)制保存。
復(fù)制并在安全的地方保存API-KEY后，單擊我已保存，關(guān)閉。此次創(chuàng)建的API-KEY可立即用于調(diào)用DashScopeAPI，對API-KEY的后續(xù)操作均可在當(dāng)前的API-KEY管理頁面進行。
說明出于安全考慮，關(guān)閉彈窗后，您可以在API KEY管理通過賬號驗證的方式再次查看API-KEY。
配置API的方式
在您獲取到API-KEY后，可在您的業(yè)務(wù)代碼中配置API-KEY值來使用DashScope的模型服務(wù)。您可以通過以下兩種方式進行配置。
方式一：通過環(huán)境變量設(shè)置API-KEY（推薦）
環(huán)境變量是操作系統(tǒng)中用于存儲有關(guān)系統(tǒng)環(huán)境的信息的變量。您可以通過環(huán)境變量來配置API-KEY，這樣即使您的代碼庫被公開，API-KEY也不會泄漏。您可以根據(jù)您的操作系統(tǒng)與使用場景來確定添加API-KEY到環(huán)境變量中的方法。
Linux系統(tǒng)
當(dāng)您使用Linux系統(tǒng)（如Ubuntu、CentOS等）中的命令行添加API-KEY為環(huán)境變量時，可以選擇在當(dāng)前會話添加臨時性環(huán)境變量，或?qū)Ξ?dāng)前用戶添加永久性環(huán)境變量。
方式一：添加臨時性環(huán)境變量
如果您僅需要在當(dāng)前會話中添加并使用臨時性環(huán)境變量，可以運行以下命令：
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"您可以在當(dāng)前會話運行以下命令檢查環(huán)境變量是否生效：
echo $DASHSCOPE_API_KEY方式二：對當(dāng)前用戶添加永久性環(huán)境變量
如果您需要對當(dāng)前用戶添加永久性環(huán)境變量，使得在該用戶的新會話中也可以使用該環(huán)境變量，可以把以下命令語句復(fù)制并添加到~/.bashrc文件中：
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"或直接運行以下命令將上述命令語句添加到~/.bashrc中：
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc添加完成后，您可以運行以下命令使環(huán)境變量生效：
source ~/.bashrc您可以新建一個會話，運行以下命令檢查環(huán)境變量是否生效：
echo $DASHSCOPE_API_KEYmacOS系統(tǒng)
當(dāng)您使用macOS系統(tǒng)中的命令行添加API-KEY為環(huán)境變量時，可以選擇在當(dāng)前會話添加臨時性環(huán)境變量，或?qū)Ξ?dāng)前用戶添加永久性環(huán)境變量。
方式一：添加臨時性環(huán)境變量
如果您僅需要在當(dāng)前會話中添加并使用臨時性環(huán)境變量，可以運行以下命令：
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"您可以在當(dāng)前會話運行以下命令檢查環(huán)境變量是否生效：
echo $DASHSCOPE_API_KEY方式二：對當(dāng)前用戶添加永久性環(huán)境變量
如果您需要對當(dāng)前用戶添加永久性環(huán)境變量，使得在該用戶的新會話中也可以使用該環(huán)境變量，您可以根據(jù)您使用的Shell類型把以下命令復(fù)制并添加到~/.zshrc或~/.bash_profile文件中。
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"或直接運行以下命令將上述命令語句添加到~/.zshrc或~/.bash_profile中：
# 用您的 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添加完成后，您可以根據(jù)使用的Shell類型運行以下命令使得環(huán)境變量生效：
# 如果您的Shell類型是Zsh，運行以下命令
source ~/.zshrc
# 如果您的Shell類型是Bash，運行以下命令
source ~/.bash_profile您可以新建一個會話，運行以下命令檢查環(huán)境變量是否生效：
echo $DASHSCOPE_API_KEYWindows系統(tǒng)
在Windows系統(tǒng)中，您可以使用CMD或PowerShell（推薦）運行命令。
CMD
當(dāng)您使用CMD中的命令行添加API-KEY為環(huán)境變量時，可以選擇在當(dāng)前會話添加臨時性環(huán)境變量，或?qū)Ξ?dāng)前用戶添加永久性環(huán)境變量。
方式一：添加臨時性環(huán)境變量
如果您僅需要在當(dāng)前會話中添加并使用臨時性環(huán)境變量，可以運行以下命令：
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
set DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY您可以在當(dāng)前會話運行以下命令檢查環(huán)境變量是否生效：
echo %DASHSCOPE_API_KEY%方式二：對當(dāng)前用戶添加永久性環(huán)境變量
當(dāng)您在CMD中需要為當(dāng)前用戶添加永久性環(huán)境變量時，可以運行以下命令：
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
setx DASHSCOPE_API_KEY "YOUR_DASHSCOPE_API_KEY"您可以新建一個會話，運行以下命令檢查環(huán)境變量是否生效：
echo %DASHSCOPE_API_KEY%PowerShell
當(dāng)您使用PowerShell中的命令行添加API-KEY為環(huán)境變量時，可以選擇在當(dāng)前會話添加臨時性環(huán)境變量，或?qū)Ξ?dāng)前用戶添加永久性環(huán)境變量。
方式一：添加臨時性環(huán)境變量
如果您僅需要在當(dāng)前會話中添加并使用臨時性環(huán)境變量，您可以運行以下命令：
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
$env:DASHSCOPE_API_KEY = "YOUR_DASHSCOPE_API_KEY"您可以在當(dāng)前會話運行以下命令檢查環(huán)境變量是否生效：
echo $env:DASHSCOPE_API_KEY方式二：對當(dāng)前用戶添加永久性環(huán)境變量
如果您在PowerShell中需要為當(dāng)前用戶添加永久性環(huán)境變量，可以運行以下命令：
# 用您的 API-KEY 代替 YOUR_DASHSCOPE_API_KEY
[Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "YOUR_DASHSCOPE_API_KEY", [EnvironmentVariableTarget]::User)您可以新建一個會話，運行以下命令檢查環(huán)境變量是否生效：
echo $env:DASHSCOPE_API_KEY方式二：在代碼中顯式配置API-KEY
我們不建議您將API-KEY直接寫在代碼中，可能存在泄露風(fēng)險。如果您沒有配置環(huán)境變量，可以參考以下示例代碼，在代碼中配置API-KEY。
請用您的API-KEY替換YOUR_DASHSCOPE_API_KEY。
import dashscope
dashscope.api_key="YOUR_DASHSCOPE_API_KEY"import com.alibaba.dashscope.utils.Constants;
# 以下賦值語句請放在類或方法中運行
Constants.apiKey="YOUR_DASHSCOPE_API_KEY";保護并正確使用API-KEY
API-KEY是訪問DashScope的密鑰，請務(wù)必妥善保存。不要以任何方式公開到外部渠道，避免因未經(jīng)授權(quán)的使用造成安全風(fēng)險或資金損失。
DashScope通過API-KEY進行調(diào)用鑒權(quán)和計量計費，而API-KEY是基于主賬號的維度生成和管理的。目前支持主賬號或者得到主賬號授權(quán)的子賬號進行API-KEY的管理，每個主賬號最多同時可以擁有3個有效的API-KEY，因此不論是主賬號還是得到授權(quán)的子賬號登錄，實際管理的API-KEY都是關(guān)聯(lián)對應(yīng)的主賬號的。API-KEY不應(yīng)被分享給未經(jīng)授權(quán)的開發(fā)者。
為了防止API-KEY的創(chuàng)建功能被濫用，每個主賬號（含對應(yīng)子賬號操作）每天僅可進行10次API-KEY新建操作。
為了保護API-KEY不被泄露，API調(diào)用應(yīng)該僅發(fā)起于服務(wù)端。任何發(fā)起自客戶端的API調(diào)用，例如瀏覽器、app、小程序等，均有可能造成API-KEY的泄露。
如懷疑API-KEY可能已經(jīng)被泄露，可以通過DashScope的管理控制臺刪除該API-KEY。API-KEY被刪除后，采用該API-KEY的后續(xù)調(diào)用均會被拒絕。
子賬號賦權(quán)步驟
DashScope也支持通過子賬號登錄控制臺進行相關(guān)的API-KEY管理、調(diào)用量查詢等日常管理工作，前提是子賬號得到了主賬號的賦權(quán)。主賬號登錄阿里云的RAM管控平臺就可以看到相關(guān)的子賬號信息，在用戶頁面，主賬號通過點擊添加權(quán)限就可以給目標(biāo)子賬號進行賦權(quán)操作。
點擊添加權(quán)限之后，在彈出的操作欄中搜索dashscope就可以看到相關(guān)的權(quán)限。對于DashScope來說，有兩種類型的權(quán)限，一種是“管理DashScope大模型的權(quán)限”，這意味這得到賦權(quán)的子賬號在DashScope擁有和主賬號同等級別的管理權(quán)限；另一種是“只讀訪問DashScope大模型的權(quán)限”，這個權(quán)限限制了子賬號只能在DashScope的管理控制臺上進行查看的權(quán)限，而不能對API-KEY等具體設(shè)置進行更改。
需要指出的是，DashScope的API-KEY關(guān)聯(lián)的是您的主賬號，也就是說，在一個主賬號之下只有一套API-KEY，主賬號之下所有的子賬號登錄之后管理或者查看的都是同樣一套API-KEY，不存在關(guān)聯(lián)某個子賬號的專屬API-KEY。所以即使是子賬號登錄，在操作API-KEY的時候也需要小心謹(jǐn)慎，因為這個操作是會在整個主賬號級別產(chǎn)生影響的。
在完成了上述賦權(quán)操作之后，得到相應(yīng)權(quán)限的子賬號就可以獨立的登錄DashScope的管理控制臺完成相應(yīng)的操作了。