获取AccessKey并配置到环境变量

更新时间:
复制为 MD 格式

AccessKey(访问密钥)是调用服务数字员工 API 时用于身份验证的凭证。本文介绍如何获取 AccessKey,以及如何在 Linux、macOS 和 Windows 系统的环境变量中配置 AccessKey。

背景信息

AccessKey 包括 AccessKey ID 和 AccessKey Secret 两部分:

  • AccessKey ID:用于标识用户身份。

  • AccessKey Secret:用于加密和验证签名字符串。AccessKey Secret 必须严格保密。

警告
  • 阿里云账号拥有所有的访问权限,风险很高。强烈建议您创建并使用 RAM 用户进行 API 调用。

  • 使用 AccessKey 调用 API 时,强烈反对在代码中明文传入 AccessKey,请配置环境变量或使用其他安全的非明文 AccessKey 方案。

  • 建议定期轮换 AccessKey,降低泄露风险。

步骤一:获取 AccessKey

您可以通过以下方式获取 AccessKey:

  1. 登录RAM 控制台

  2. 在左侧导航栏,选择身份管理 > 用户

  3. 找到目标 RAM 用户,单击用户名称。

  4. AccessKey页签,单击创建 AccessKey

  5. 完成手机或邮箱验证后,系统会显示 AccessKey ID 和 AccessKey Secret。

    说明

    AccessKey Secret 只在创建时显示一次,请务必立即保存。如果忘记 AccessKey Secret,只能重新创建。

如果 RAM 用户没有调用服务数字员工 API 的权限,需要先为 RAM 用户授权。授权方法请参见为 RAM 用户授权

步骤二:在 Linux 和 macOS 系统配置环境变量

以设置环境变量 ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET 为例。您可以根据实际需要修改变量名称。

方法一:临时配置(使用 export 命令)

使用 export 命令配置的环境变量仅对当前会话有效,当会话退出之后所设置的环境变量将会丢失。

  1. 配置 AccessKey ID 并按回车。

    export ALIBABA_CLOUD_ACCESS_KEY_ID=yourAccessKeyID

    将 yourAccessKeyID 替换为您自己的 AccessKey ID。

  2. 配置 AccessKey Secret 并按回车。

    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=yourAccessKeySecret

    将 yourAccessKeySecret 替换为您自己的 AccessKey Secret。

  3. 验证是否配置成功。

    echo $ALIBABA_CLOUD_ACCESS_KEY_ID

    如果返回正确的 AccessKey ID,则说明配置成功。

方法二:永久配置(写入启动文件)

若需长期保留环境变量,可将 export 命令配置到操作系统的启动配置文件中。

  1. 根据您使用的 Shell,选择对应的配置文件:

    • Bash:~/.bashrc 或 ~/.bash_profile

    • Zsh:~/.zshrc

  2. 在配置文件末尾添加以下内容:

    export ALIBABA_CLOUD_ACCESS_KEY_ID=yourAccessKeyID
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=yourAccessKeySecret
  3. 保存文件后,执行以下命令使配置生效:

    source ~/.bashrc  # 或 source ~/.zshrc

步骤三:在 Windows 系统配置环境变量

以设置环境变量 ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET 为例。您可以根据实际需要修改变量名称。

方法一:通过图形界面配置

以 Windows 10 为例,通过图形用户界面设置环境变量的步骤如下:

  1. 在桌面右键单击此电脑,选择属性 > 高级系统设置 > 环境变量

  2. 系统变量用户变量区域,单击新建

    说明
    • 系统变量:对所有用户生效。

    • 用户变量:仅对当前用户生效。

  3. 配置 AccessKey ID:

    • 变量名:ALIBABA_CLOUD_ACCESS_KEY_ID

    • 变量值:您的 AccessKey ID(例如:LTAI****************)

    单击确定

  4. 重复步骤 2 和 3,配置 AccessKey Secret:

    • 变量名:ALIBABA_CLOUD_ACCESS_KEY_SECRET

    • 变量值:您的 AccessKey Secret

  5. 单击确定保存所有更改。

方法二:通过命令提示符配置

  1. 以管理员身份打开命令提示符。

  2. 执行以下命令配置环境变量:

    setx ALIBABA_CLOUD_ACCESS_KEY_ID yourAccessKeyID /M
    setx ALIBABA_CLOUD_ACCESS_KEY_SECRET yourAccessKeySecret /M
    说明

    /M 参数表示设置系统级环境变量。如果要设置用户级环境变量,可以省略该参数。

方法三:通过 PowerShell 配置

PowerShell 提供了更灵活的环境变量配置方式。

设置用户级环境变量:

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID','yourAccessKeyID', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET','yourAccessKeySecret', [System.EnvironmentVariableTarget]::User)

设置系统级环境变量(需要管理员权限):

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID','yourAccessKeyID', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET','yourAccessKeySecret', [System.EnvironmentVariableTarget]::Machine)

设置临时环境变量(仅对当前会话有效):

$env:ALIBABA_CLOUD_ACCESS_KEY_ID="yourAccessKeyID"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET="yourAccessKeySecret"

验证配置

  1. 打开新的命令提示符窗口(或 PowerShell 窗口)。

  2. 执行以下命令验证配置:

    命令提示符:

    echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
    echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%

    PowerShell:

    Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID
    Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET
  3. 如果返回正确的 AccessKey,则说明配置成功。

后续步骤

  • 环境变量配置完成后,建议重启开发工具(IDE)或服务,确保新的设置被正确应用。

  • 配置完成后,您可以开始安装 SDK 并调用服务数字员工 API。