凭证配置相关命令
本文介绍阿里云CLI配置命令及使用示例。
交互式创建配置
您可以使用aliyun configure
命令,以交互式方式创建配置。
命令语法
aliyun configure [--mode <AuthenticateMode>] [--profile <ProfileName>]
AuthenticateMode
:指定要设置的凭证类型。若参数为空,则默认创建AK类型凭证配置。ProfileName
:指定配置名称。若不使用该选项,将优先修改当前配置。若指定配置不存在则新建配置。
调用示例
执行如下命令,使用交互式方式创建AK类型凭证配置
AkProfile
。aliyun configure --mode AK --profile AkProfile
交互过程如下所示。
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
:指定配置参数。创建配置时需参考身份凭证类型,设置对应类型中所有必填项,否则将创建失败。AuthenticateMode
:指定凭证类型。若参数为空,则默认创建AK类型凭证配置。ProfileName
:指定配置名称。若参数为空且未配置环境变量ALIBABA_CLOUD_PROFILE
,则优先修改当前配置。若指定配置不存在则创建新配置。
示例一:非交互式创建配置
执行如下命令,使用非交互式方式创建AK类型凭证配置
AkProfile
。aliyun configure set \ --access-key-id <yourAccessKeyID> \ --access-key-secret <yourAccessKeySecret> \ --region cn-hangzhou \ --profile AkProfile \ --mode AK \ --language en
执行
aliyun configure list
命令,终端输出如下信息。则配置AkProfile
已成功创建。Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- default | AK:****** | Valid | cn-beijing | zh AkProfile * | AK:****** | Valid | cn-hangzhou | en
示例二:修改指定配置
执行
aliyun configure get region
命令,终端返回当前配置中的地域ID。执行如下命令,将当前配置的地域ID修改至
cn-shanghai
。aliyun configure set --region cn-shanghai
再次执行
aliyun configure get region
命令,验证修改结果。
获取配置列表
您可以使用aliyun configure list
命令获取配置列表,在列表中查看全部配置的概要信息。
调用示例
执行如下命令,获取凭证配置列表。
aliyun configure list
终端返回如下配置列表。
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
:指定要查看的设置项,可同时指定多项设置,未指定时显示全部设置项。若指定的设置项不存在,命令执行后终端不返回信息。ProfileName
:指定配置名称。若该参数为空且未配置环境变量ALIBABA_CLOUD_PROFILE
,则优先查看当前配置信息。若指定配置不存在,则提示profile <ProfileName> not found!
。
示例一:查看指定配置全部设置信息
执行如下命令,查看AK类型凭证配置
AkProfile
的全部设置项。aliyun configure get --profile AkProfile
返回结果。
{ "name": "AkProfile", "mode": "AK", "access_key_id": "<yourAccessKeyID>", "access_key_secret": "<yourAccessKeySecret>", "region_id": "cn-hangzhou", "output_format": "json", "language": "en" }
示例二:查看指定配置部分设置信息
执行如下命令,查看External类型凭证配置
ExternalProfile
的配置名称、凭证类型及默认语言。aliyun configure get profile mode language --profile ExternalProfile
终端以
key=value
格式返回设置详情。profile=ExternalProfile mode=External language=en
切换当前配置
您可以使用aliyun configure switch
命令当前配置切换为指定配置。该命令的最低支持版本为v3.0.216
。
命令语法
aliyun configure switch --profile <ProfileName>
ProfileName
:指定配置名称,该选项为必填项。若参数为空或配置不存在,命令执行失败。
调用示例
执行
aliyun configure list
命令获取配置列表,可知当前配置为default
(阿里云CLI使用星形标示号*
标记当前配置,该记号位于配置名称右侧)。Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- default * | AK:****** | Valid | cn-hangzhou | en ExampleProfile | AK:****** | Valid | cn-beijing | zh
执行如下命令,将当前配置切换为
ExampleProfile
。设置成功后终端返回信息The default profile is `ExampleProfile` now.
。aliyun configure switch --profile exampleProfile
再次执行
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
文件夹中。
调用示例
执行
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
执行如下命令,删除配置
ExampleProfile
。aliyun configure delete --profile ExampleProfile
再次执行
aliyun configure list
命令,配置ExampleProfile
成功删除,当前配置已切换为default
。Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- default * | AK:****** | Valid | cn-hangzhou | en AkProfile | AK:****** | Valid | cn-hangzhou | en
- 本页导读 (1)
- 交互式创建配置
- 命令语法
- 调用示例
- 非交互式创建或修改配置
- 命令语法
- 示例一:非交互式创建配置
- 示例二:修改指定配置
- 获取配置列表
- 调用示例
- 查看指定配置信息
- 命令语法
- 示例一:查看指定配置全部设置信息
- 示例二:查看指定配置部分设置信息
- 切换当前配置
- 命令语法
- 调用示例
- 删除指定配置
- 命令语法
- 调用示例