配置项参数概述
如果您需要同时在多个区域或多个项目下管理资源,或者同时使用多个账号,可以通过增加配置项的方式,存储多个不同场景的固定信息。已配置多个配置项的情况下,您可在命令中以“--cli-profile”指定要操作或使用的配置项的名称。
KooCLI配置项中可修改的参数如下表所示。
| 参数名 | 说明 |
|---|---|
| cli-profile | 配置项名称。如果修改配置项时不指定此参数,则修改默认配置项。执行“hcloud configure show”命令可查看默认配置项的内容。 |
| cli-mode | 认证模式。取值范围:
|
| 区域。 | |
| 访问密钥ID(Access Key ID,简称AK),此参数必须和SK同步修改。 | |
| 秘密访问密钥(Secret Access Key,简称SK),此参数必须和AK同步修改。 | |
| 临时安全凭证。在使用临时AK/SK认证身份时,需同时使用此参数。注意过期后需重新配置,否则调用云服务API时无法完成认证。 | |
| cli-local-dea | 本地加密保存的认证信息及custom参数的加密算法。取值范围:
|
| cli-lang | KooCLI的语言。取值范围:
|
| cli-offline | 是否使用KooCLI的离线模式。取值范围:
|
| 项目ID。 | |
| IAM用户所属账号ID,以AKSK模式调用全局服务的API时需要。 | |
| cli-custom | 是否操作custom参数。取值范围:
|
| cli-read-timeout | I/O超时时间(秒)。默认取值为10秒,参数最小取值为1秒。 |
| cli-connect-timeout | 请求连接超时时间(秒)。默认取值为5秒,参数最小取值为1秒。 |
| cli-retry-count | 请求连接重试次数。默认取值为0次,可配置的取值范围为0~5次。 |
| cli-skip-secure-verify | 是否跳过https请求证书验证(不建议)。取值范围:
|
| cli-agency-domain-name | 委托方的账号名称,必须和cli-agency-name同时使用 |
| cli-agency-domain-id | 委托方的账号ID,必须和cli-agency-name同时使用 |
| cli-agency-name | 委托名称,必须和cli-agency-domain-id或cli-agency-domain-name同时使用 |
| cli-source-profile | 保存被委托方认证信息的配置项。配置项的cli-source-profile取值不能是当前配置项。 |
| cli-agree-privacy-statement | 是否同意隐私。首次使用KooCLI时,KooCLI会通过交互,提示用户阅读并同意隐私声明。对于不方便交互的场景,如以自动化脚本执行命令,可通过此参数配置同意隐私声明。取值范围:
|
| cli-warning | 是否提示命令执行过程中的Warning信息。以自动化脚本执行命令时,关闭Warning提示信息,可以避免干扰解析命令执行的输出结果。取值范围:
|
| cli-auth-encrypt | 配置文件中的认证信息是否加密存储。取值范围:
|
| cli-sso-start-url | 用户门户URL,开通IAM身份中心后生成。 |
| cli-sso-region | 开通IAM身份中心实例所在的区域。 |
| cli-sso-account-name | 账号名。 |
| cli-sso-permission-set-name | 权限集名称。 |
- 参数“--cli-custom”的取值可标识向配置项中设置的参数类型:当“--cli-custom=false”时,设置其中的系统参数;当“--cli-custom=true”时,设置其中的custom(即用户自定义)参数。
- 设置配置项中的系统参数时,若该配置项不存在则新增配置项,否则修改该配置项。
- 不支持向不存在的配置项中设置custom参数;不支持在同一命令中同时设置系统参数和custom参数。
- 向配置项中设置系统参数或custom参数,都会使该配置项成为默认配置项。
新增或修改配置项的命令为:
hcloud configure set --param1=paramValue1 --param2=paramValue2 ...