获取与配置 API Key

​

第一步：获取 API Key

1. 前往阿里云百炼的密钥管理（中国大陆版 | 国际版）页面。
2. 若已有可用 API Key，直接在列表中复制即可。若需创建，请遵循以下步骤：
   1. 在API Key 页签单击创建 API Key。若无法创建，请联系您的组织或 IT 管理员。
   2. 在创建 API Key弹窗中，选择 API Key 的归属账号及归属业务空间，并单击确定。
      • 归属账号：选择阿里云账号（主账号）即可，账号名通常为一串数字。 如需为团队成员或应用创建权责独立的 API Key，并结合归属业务空间进行精细化的模型访问控制，归属账号应选择RAM 用户。

        RAM 用户的账号格式为username@<AccountAlias>.onaliyun.com。

      • 归属业务空间：选择“默认业务空间”，此空间下的 Key 可调用所有标准模型。

        单个业务空间最多支持创建 20 个 API Key。

        如需以下功能，请选择非默认的业务空间，相关信息请参考业务空间管理：
        • 对不同项目（业务空间）进行权限隔离
        • 精细化的模型访问控制
        • 进行独立的成本核算
      • 权限：建议选择全部，若有更精细的权限控制需求，可以选择自定义来控制可访问 IP 和 可访问模型。

        IP 白名单默认设置：IPv4（0.0.0.0/0）全部放通；IPv6 仅华北2（北京）地域支持，美国（弗吉尼亚）地域仅支持 IPv4。最多支持 20 个地址或网段，批量输入请用英文逗号隔开。

   3. 点击新创建的 API Key 旁的图标复制 API Key。

​

第二步：配置 API Key

• 方式一：在第三方工具中进行配置 如果在 Chatbox 等工具或平台中调用模型，您可能需要输入三个信息：
  • 本文获取的 API Key
  • Base URL：
    • 中国大陆版：https://dashscope.aliyuncs.com/compatible-mode/v1
    • 国际版：https://dashscope-intl.aliyuncs.com/compatible-mode/v1
  • 模型名称，如 qwen-plus、qwen3-8b、deepseek-r1 等。
  我们也提供了一些常用工具的配置方法：Dify、Chatbox、Cline、Claude Code、Postman。
• 方式二：配置 API Key 到环境变量，后续支持 cURL 和代码调用
  请勿在客户端代码（如浏览器、移动应用）或不可信环境中配置或使用长期有效的 API Key。可以使用临时 API Key（最长 1800 秒）。

  请将<YOUR_API_KEY> 部分替换为真实的 API Key。

  • Linux系统
  • macOS系统
  • Windows系统

  • 添加永久性环境变量
  • 添加临时性环境变量
  • 服务管理器 (systemd)

  将环境变量设置追加到~/.bashrc文件中。

  Copy

  echo "export DASHSCOPE_API_KEY='<YOUR_API_KEY>'" >> ~/.bashrc
  source ~/.bashrc
  echo "百炼 API Key 永久配置为：${DASHSCOPE_API_KEY:0:10}*********"
  

  Copy

  export DASHSCOPE_API_KEY='<YOUR_API_KEY>'
  echo "当前会话百炼 API Key 配置为：${DASHSCOPE_API_KEY:0:10}*********"
  

  以下操作适用于将应用作为后台服务部署的场景。

  1. 创建环境文件

  Copy

  sudo sh -c "echo 'DASHSCOPE_API_KEY=<YOUR_API_KEY>' > /etc/your-app/env"
  sudo chmod 600 /etc/your-app/env # 限制只有root用户有访问权限
  

  2. 修改 systemd 服务文件（如 /etc/systemd/system/your-app.service）：

  Copy

  [Service]
  # 加载密钥文件
  EnvironmentFile=/etc/your-app/env
  ExecStart=/usr/bin/python /opt/your-app/main.py
  

  3. 重载服务

  Copy

  sudo systemctl daemon-reload
  sudo systemctl restart your-app
  

  • 添加永久性环境变量
  • 添加临时性环境变量

  将环境变量设置追加到~/.bash_profile或~/.zshrc文件中。

  Copy

  VAR_VALUE="<YOUR_API_KEY>"; \
  echo "export DASHSCOPE_API_KEY='$VAR_VALUE'" >> ~/.zshrc 2>/dev/null
  echo "export DASHSCOPE_API_KEY='$VAR_VALUE'" >> ~/.bash_profile 2>/dev/null
  source ~/."${SHELL##*/}rc" 2>/dev/null
  echo "百炼 API Key 永久配置为：${DASHSCOPE_API_KEY:0:10}*********"
  

  Copy

  export DASHSCOPE_API_KEY='<YOUR_API_KEY>'
  echo "当前会话百炼 API Key 配置为：${DASHSCOPE_API_KEY:0:10}*********"
  

  在Windows系统中，您可以通过系统属性、CMD或PowerShell配置环境变量。

  • 系统属性
  • CMD
  • PowerShell

  • 此方式配置的环境变量永久生效。
  • 修改系统环境变量需具备管理员权限。
  • 配置环境变量后不会立即影响已经打开的命令窗口、IDE或其他正在运行的应用程序。您需要重新启动这些程序或者打开新的命令行使环境变量生效。

  1. 在Windows系统桌面中按Win+Q键，在搜索框中搜索编辑系统环境变量，单击打开系统属性界面。
  2. 在系统属性窗口，单击环境变量，然后在系统变量区域下单击新建，变量名填入DASHSCOPE_API_KEY，变量值填入您的DashScope API Key。
  3. 依次单击三个窗口的确定，关闭系统属性配置页面，完成环境变量配置。
  4. 打开CMD（命令提示符）窗口或Windows PowerShell窗口，执行如下命令检查环境变量是否生效。
     • CMD查询命令：

  Copy

  echo 百炼 API Key 永久配置为：%DASHSCOPE_API_KEY:~0,10%*********
  

  • Windows PowerShell查询命令：

  Copy

  Write-Host "百炼 API Key 永久配置为：$($env:DASHSCOPE_API_KEY.Substring(0, [Math]::Min(10, $env:DASHSCOPE_API_KEY.Length)))*********"
  

  • 添加永久性环境变量
  • 添加临时性环境变量

  如果您希望API Key环境变量在当前用户的所有新会话中生效，可以按如下操作。

  1. 在CMD中运行以下命令。

  Copy

  setx DASHSCOPE_API_KEY "<YOUR_API_KEY>"
  

  2. 打开一个新的CMD窗口。
  3. 在新的CMD窗口运行以下命令，检查环境变量是否生效。

  Copy

  echo 百炼 API Key 永久配置为：%DASHSCOPE_API_KEY:~0,10%*********
  

  如果您仅希望在当前会话中使用该环境变量，可以在CMD中运行以下命令。

  Copy

  set "DASHSCOPE_API_KEY=<YOUR_API_KEY>"
  

  您可以在当前会话运行以下命令检查环境变量是否生效。

  Copy

  echo 当前会话百炼 API Key 配置为：%DASHSCOPE_API_KEY:~0,10%*********
  

  • 添加永久性环境变量
  • 添加临时性环境变量

  如果您希望API Key环境变量在当前用户的所有新会话中生效，可以按如下操作。

  1. 在PowerShell中运行以下命令。

  Copy

  [Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "<YOUR_API_KEY>", [EnvironmentVariableTarget]::User)
  

  2. 打开一个新的PowerShell窗口。
  3. 在新的PowerShell窗口运行以下命令，检查环境变量是否生效。

  Copy

  Write-Host "百炼 API Key 永久配置为：$($env:DASHSCOPE_API_KEY.Substring(0, [Math]::Min(10, $env:DASHSCOPE_API_KEY.Length)))*********"
  

  如果您仅希望在当前会话中使用该环境变量，可以在PowerShell中运行以下命令。

  Copy

  $env:DASHSCOPE_API_KEY = "<YOUR_API_KEY>"
  Write-Host "当前会话百炼 API Key 配置为：$($env:DASHSCOPE_API_KEY.Substring(0, [Math]::Min(10, $env:DASHSCOPE_API_KEY.Length)))*********"
  

​

API Key 时效性说明

API Key 没有失效时间限制，若需要有时效性的 API Key，可生成临时 API Key（有效期最多1800秒）。 API Key 的状态随账号操作而变化：

触发操作	主账号的 API Key	RAM 账号的 API Key
主动删除 API Key	不支持 失效，不可恢复	不支持 失效，不可恢复
将账号移出业务空间	—	不支持 失效 重新加入业务空间后 API Key 恢复生效
在RAM 控制台删除账号/角色	—	不支持 失效，不可恢复

​

API 调用

请访问文本生成以及更多模型的 API 参考。 OpenAI SDK 支持的模型，请参考OpenAI 兼容。

​

常见问题

​

无法创建 API Key？

API Key 的创建需使用超级管理员或业务空间管理员操作。

​

如何管理 API Key 的权限？

API Key 的调用权限完全由其归属业务空间决定。同一空间内的 API Key 权限相同，无需为不同模型（如文生文、文生图、语音合成）创建不同的 API Key。

• 默认业务空间下的 API Key：可调用所有标准模型，以及默认业务空间内的应用。
• 子业务空间下的 API Key：可调用该子业务空间已获得模型调用授权的标准模型，以及该业务空间内的应用。

调用在阿里云百炼调优后的模型：此类模型部署成功后，仅能用其所在业务空间的API Key调用。 如需在业务空间之外做更细粒度的控制，可在创建或编辑 API Key 时将权限切换为自定义，配置：

• IP 访问白名单：仅允许名单内的 IP 使用该 API Key 发起调用。支持 IPv4 与网段，默认 IPv4（0.0.0.0/0）全部放通；IPv6 仅华北2（北京）地域支持，美国（弗吉尼亚）地域仅支持 IPv4。最多支持 20 个地址或网段，批量输入请用英文逗号隔开。
• 访问模型范围：开关开启后，该 API Key 仅能调用已勾选的模型，可选模型限于该业务空间已授权的模型。

​

环境变量已设置，为何代码仍提示找不到 API Key？

具体原因如下：

• 情况一：没有设置永久性环境变量。临时环境变量只在当前终端会话中有效，对于已经启动的 IDE 或其他应用程序并不会生效。请参考本文中设置永久性环境变量的方法。
• 情况二：没有重启IDE、命令行工具或应用。
  • 通常需要重启 IDE（如 VS Code）或命令行工具，使其能够加载最新的环境变量。
  • 如果在部署应用后设置了环境变量，可能需要重启应用服务，让应用能够重新加载环境变量。
• 情况三：需要在配置文件添加环境变量。如果您的应用是通过服务管理器（如 systemd、supervisord）启动的，可能需要在服务管理器的配置文件中添加环境变量。
• 情况四：用了sudo命令。如果使用sudo python xx.py运行脚本，可能会遗漏当前用户环境变量，因为sudo默认不继承所有环境变量。您可采用sudo -E python xx.py命令，其中的-E 参数确保环境变量被传递。如有权限执行该脚本，可以直接执行 python xx.py。

​

单个主账号下最多能创建多少个API Key？

每个主账号下最多可创建20个业务空间（包括默认业务空间），每个业务空间下最多可创建20个API Key。