凭证配置相关命令

更新时间:2025-03-28 05:29:14

本文介绍阿里云CLI配置命令及使用示例。

交互式创建配置

您可以使用aliyun configure命令,以交互式方式创建配置。

命令语法

aliyun configure [--mode <AuthenticateMode>] [--profile <ProfileName>]
  • AuthenticateMode:指定要设置的凭证类型。若参数为空,则默认创建AK类型凭证配置。

  • ProfileName:指定配置名称。若不使用该选项,将优先修改当前配置。若指定配置不存在则新建配置。

调用示例

  1. 执行如下命令,使用交互式方式创建AK类型凭证配置AkProfile

    aliyun configure --mode AK --profile AkProfile
  2. 交互过程如下所示。

    Configuring profile 'AkProfile' in 'AK' authenticate mode...
    Access Key Id []: <yourAccessKeyID>
    Access Key Secret []: <yourAccessKeySecret>
    Default Region Id []: cn-hangzhou
    Default Output Format [json]: json (Only support json)
    Default Language [zh|en] en: en
    Saving profile[profile] ...Done.

非交互式创建或修改配置

您可以使用aliyun configure set命令,以非交互式方式创建或修改配置。

说明

成功修改配置后,阿里云CLI会将被修改配置切换为当前配置。

命令语法

aliyun configure set [--settingName <SettingValue>...] [--mode <AuthenticateMode>] [--profile <ProfileName>]
  • SettingName:指定配置参数。创建配置时需参考身份凭证类型,设置对应类型中所有必填项,否则将创建失败。

    可用选项列表

    选项

    说明

    示例值

    --access-key-id

    阿里云账号或 RAM 用户的AccessKey ID。

    yourAccessKeyID

    --access-key-secret

    阿里云账号或 RAM 用户的AccessKey Secret。

    yourAccessKeySecret

    --ram-role-name

    RAM角色名称。

    ECSAdmin

    --ram-role-arn

    RAM角色ARN。

    acs:ram::012345678910****:role/Alice

    --role-session-name

    角色会话名称。

    alice

    --language

    帮助信息语言。

    zh

    --region

    默认地域ID。

    cn-hangzhou

    --read-timeout

    I/O超时时间(单位:秒)。

    10

    --connect-timeout

    连接超时时间(单位:秒)。

    10

    --retry-count

    重试次数。

    5

    --expired-seconds

    凭证过期时间。

    900

    --process-command

    外部程序运行命令。

    acs-sso login --profile sso

    --oidc-provider-arn

    OIDC提供商ARN。

    acs:ram::012345678910****:oidc-provider/TestOidcIdp

    --oidc-token-file

    OIDC Token文件路径。

    /path/to/oidctoken

  • AuthenticateMode:指定凭证类型。若参数为空,则默认创建AK类型凭证配置。

  • ProfileName:指定配置名称。若参数为空且未配置环境变量ALIBABA_CLOUD_PROFILE,则优先修改当前配置。若指定配置不存在则创建新配置。

示例一:非交互式创建配置

  1. 执行如下命令,使用非交互式方式创建AK类型凭证配置AkProfile

    aliyun configure set \
      --access-key-id <yourAccessKeyID> \
      --access-key-secret <yourAccessKeySecret> \
      --region cn-hangzhou \
      --profile AkProfile \
      --mode AK \
      --language en
  2. 执行aliyun configure list命令,终端输出如下信息。则配置AkProfile已成功创建。

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    default           | AK:******             | Valid   | cn-beijing       | zh
    AkProfile *       | AK:******             | Valid   | cn-hangzhou      | en

示例二:修改指定配置

  1. 执行aliyun configure get region命令,终端返回当前配置中的地域ID。

    image

  2. 执行如下命令,将当前配置的地域ID修改至cn-shanghai

    aliyun configure set --region cn-shanghai
  3. 再次执行aliyun configure get region命令,验证修改结果。

    image

获取配置列表

您可以使用aliyun configure list命令获取配置列表,在列表中查看全部配置的概要信息。

调用示例

  1. 执行如下命令,获取凭证配置列表。

    aliyun configure list
  2. 终端返回如下配置列表。

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    AkProfile *       | AK:******             | Valid   | cn-beijing       | en
    StsTokenProfile   | StsToken:******       | Valid   | cn-hangzhou      | en
    RamRoleArnProfile | RamRoleArn:******     | Valid   | cn-shanghai      | en
    EcsRamRoleProfile | EcsRamRole:ECSAdmin   | Valid   | cn-qingdao       | zh

    配置列表包含以下概要信息:配置名称、当前配置标记(阿里云CLI使用星形标示号*标记当前配置,该记号位于配置名称右侧)、部分凭证信息、凭据有效性、默认地域ID以及帮助信息语言。

查看指定配置信息

您可以使用aliyun configure get命令查看指定配置的详细信息。

命令语法

aliyun configure get [SettingName...] [--profile <ProfileName>]
  • SettingName:指定要查看的设置项,可同时指定多项设置,未指定时显示全部设置项。若指定的设置项不存在,命令执行后终端不返回信息。

    可用参数列表

    命令参数

    说明

    关联配置字段

    profile

    配置名称。

    name

    mode

    凭证类型。

    mode

    access-key-id

    阿里云账号或 RAM 用户的AccessKey ID。

    access_key_id

    access-key-secret

    阿里云账号或 RAM 用户的AccessKey Secret。

    access_key_secret

    sts-token

    RAM用户或角色的临时身份凭证STS Token。

    sts_token

    sts-region

    RAM用户或角色获取临时身份凭证时发起调用的地域ID。

    sts_region

    ram-role-name

    RAM角色名称。

    ram_role_name

    ram-role-arn

    RAM角色ARN。

    ram_role_arn

    role-session-name

    角色会话名称。

    ram_session_name

    language

    帮助信息语言。

    language

    region

    默认地域ID。

    region_id

  • ProfileName:指定配置名称。若该参数为空且未配置环境变量ALIBABA_CLOUD_PROFILE,则优先查看当前配置信息。若指定配置不存在,则提示profile <ProfileName> not found!

示例一:查看指定配置全部设置信息

  1. 执行如下命令,查看AK类型凭证配置AkProfile的全部设置项。

    aliyun configure get --profile AkProfile
  2. 返回结果。

    {
            "name": "AkProfile",
            "mode": "AK",
            "access_key_id": "<yourAccessKeyID>",
            "access_key_secret": "<yourAccessKeySecret>",
            "region_id": "cn-hangzhou",
            "output_format": "json",
            "language": "en"
    }

示例二:查看指定配置部分设置信息

  1. 执行如下命令,查看External类型凭证配置ExternalProfile的配置名称、凭证类型及默认语言。

    aliyun configure get profile mode language --profile ExternalProfile
  2. 终端以key=value格式返回设置详情。

    profile=ExternalProfile
    mode=External
    language=en

切换当前配置

您可以使用aliyun configure switch命令当前配置切换为指定配置。该命令的最低支持版本为v3.0.216

命令语法

aliyun configure switch --profile <ProfileName>

ProfileName:指定配置名称,该选项为必填项。若参数为空或配置不存在,命令执行失败。

调用示例

  1. 执行aliyun configure list命令获取配置列表,可知当前配置为default(阿里云CLI使用星形标示号*标记当前配置,该记号位于配置名称右侧)。

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    default *         | AK:******             | Valid   | cn-hangzhou      | en
    ExampleProfile    | AK:******             | Valid   | cn-beijing       | zh
  2. 执行如下命令,将当前配置切换为ExampleProfile设置成功后终端返回信息The default profile is `ExampleProfile` now.

    aliyun configure switch --profile exampleProfile
  3. 再次执行aliyun configure list命令,确认当前配置已更新。

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    default           | AK:******             | Valid   | cn-hangzhou      | en
    ExampleProfile *  | AK:******             | Valid   | cn-beijing       | zh

删除指定配置

您可以使用aliyun configure delete命令删除指定配置。

命令语法

aliyun configure delete --profile <ProfileName>
  • ProfileName:指定待删除的配置名称,该选项为必填项。若传入参数为空或配置不存在,命令执行失败。

  • 若要删除的配置为当前配置,则删除完成后自动将配置列表最顶端配置切换为当前配置,详情请参见调用示例。

  • 建议保留至少一项配置。如果您误操作导致清空凭证配置,则阿里云CLI将无法正常工作。您需要手动删除config.json文件以解决此问题,该文件位于您个人用户目录下的.aliyun文件夹中。

调用示例

  1. 执行aliyun configure list命令,查看配置列表。

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    default           | AK:******             | Valid   | cn-hangzhou      | en
    AkProfile         | AK:******             | Valid   | cn-hangzhou      | en
    ExampleProfile *  | AK:******             | Valid   | cn-hangzhou      | en
  2. 执行如下命令,删除配置ExampleProfile

    aliyun configure delete --profile ExampleProfile
  3. 再次执行aliyun configure list命令,配置ExampleProfile成功删除,当前配置已切换为default

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    default *         | AK:******             | Valid   | cn-hangzhou      | en
    AkProfile         | AK:******             | Valid   | cn-hangzhou      | en

  • 本页导读 (1)
  • 交互式创建配置
  • 命令语法
  • 调用示例
  • 非交互式创建或修改配置
  • 命令语法
  • 示例一:非交互式创建配置
  • 示例二:修改指定配置
  • 获取配置列表
  • 调用示例
  • 查看指定配置信息
  • 命令语法
  • 示例一:查看指定配置全部设置信息
  • 示例二:查看指定配置部分设置信息
  • 切换当前配置
  • 命令语法
  • 调用示例
  • 删除指定配置
  • 命令语法
  • 调用示例
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等