设置配置项中的系统参数

设置配置项中的系统参数的示例如下：

• 增加配置项

  新增配置项时，以“--cli-profile”声明配置项的名称，示例如下：

  • 新增认证模式为AK/SK的配置项，其中认证参数为访问密钥，即永久AK（cli-access-key）和SK（cli-secret-key）：

    hcloud configure set --cli-profile=testAKSK --cli-mode=AKSK --cli-region=ap-southeast-1 --cli-access-key=******** --cli-secret-key=******** --cli-project-id=068119468****************af89d2e --cli-domain-id=094518e46****************cfbc4c0 --cli-read-timeout=10 --cli-connect-timeout=5

  • 新增认证模式为AK/SK的配置项，其中认证参数为临时安全凭证，即临时AK（cli-access-key），SK（cli-secret-key）和SecurityToken（cli-security-token）：

    hcloud configure set --cli-profile=testAKSKST --cli-mode=AKSK --cli-region=ap-southeast-1 --cli-access-key=******** --cli-secret-key=******** --cli-security-token=******** --cli-project-id=068119468****************af89d2e --cli-domain-id=094518e46****************cfbc4c0 --cli-read-timeout=10 --cli-connect-timeout=5

    当配置项的认证模式为AK/SK时，若该配置项中同时配置了cli-security-token参数值，则默认其中cli-access-key和cli-secret-key为临时AK/SK，否则为永久AK/SK。

  • 新增认证模式为ecsAgency的配置项，无需添加认证参数：

    hcloud configure set --cli-profile=testEcsAgency --cli-mode=ecsAgency --cli-region=ap-southeast-1 --cli-read-timeout=10 --cli-connect-timeout=5

    当在被委托的ECS服务器中使用KooCLI调用云服务API时，会根据ECS委托自动获取临时认证信息。

  • 新增认证模式为SSO的配置项，其中认证参数为用户门户URL（cli-sso-start-url），开通IAM身份中心实例所在的区域（cli-sso-region），账号名（cli-sso-account-name），权限集名称（cli-sso-permission-set-name），其中参数cli-sso-account-name与cli-sso-permission-set-name非必填：
    1. 先新增认证模式为SSO的配置项：

       hcloud configure set --cli-profile=testSSO --cli-mode=SSO --cli-region=ap-southeast-1 --cli-sso-start-url=https://idcenter.huaweicloud.com/d-3********6/portal --cli-sso-region=ap-southeast-1 --cli-sso-account-name=ACCOUNT_01 --cli-sso-permission-set-name=PERMISSION_01

    2. 进行SSO登录，若第一步中未配置cli-sso-account-name与cli-sso-permission-set-name参数，登录过程中需按照提示选择账号名与权限集名称：

       hcloud configure sso --cli-profile=testSSO

• 切换默认配置项
  用户已配置多个配置项时，可执行如下命令切换默认配置项：

  hcloud configure set --cli-profile=test

• 切换语言
  语言切换后，将作用于所有配置项。切换语言的命令为：

  hcloud configure set --cli-lang=cn

• 切换在线/离线模式

  在线/离线模式切换后，将作用于所有配置项。切换为在线模式的命令为：

  hcloud configure set --cli-offline=false

• 修改是否提示Warning信息

  是否提示Warning信息修改后，将作用于所有配置项。以自动化脚本执行命令时，关闭Warning提示信息，可以避免干扰解析命令执行的输出结果。关闭Warning信息的命令为：

  hcloud configure set --cli-warning=false

• 修改是否同意隐私声明

  是否同意隐私声明修改后，将作用于所有配置项。首次使用KooCLI时，KooCLI会通过交互，提示用户阅读并同意隐私声明。对于不方便交互的场景，如以自动化脚本执行命令，可通过如下命令配置同意隐私声明：

  hcloud configure set --cli-agree-privacy-statement=true

• 修改是否加密存储配置文件中的认证信息

  是否加密存储配置文件中的认证信息修改后，将作用于所有配置项。可通过如下命令配置不加密存储配置文件中的认证信息：

  hcloud configure set --cli-auth-encrypt=false

• 修改指定配置项的认证模式
  同一配置项可同时配置多种认证模式相关的参数。通过如下命令可指定该配置项的认证模式：

  hcloud configure set --cli-profile=test --cli-mode=AKSK

• 修改指定配置项的区域

  hcloud configure set --cli-profile=test --cli-region=ap-southeast-1

• 修改指定配置项的AK/SK

  AK和SK必须一起修改：

  hcloud configure set --cli-profile=test --cli-access-key=******** --cli-secret-key=********

• 修改指定配置项的项目ID

  部分云服务的API需要指定项目ID，用户可先获取项目ID，再将常用的项目ID添加到配置项中：

  hcloud configure set --cli-profile=test --cli-project-id=068119468****************af89d2e

• 修改指定配置项的请求连接超时时间

  hcloud configure set --cli-profile=test --cli-connect-timeout=5

• 修改指定配置项的I/O超时时间

  hcloud configure set --cli-profile=test --cli-read-timeout=10

• 修改指定配置项的请求连接重试次数

  hcloud configure set --cli-profile=test --cli-retry-count=3

  

  需要注意的是，因为使用“--cli-retry-count”设置重试次数可能会导致调用接口幂等性的问题，有重复调用的风险。对于创建类的接口，请您谨慎使用。

• 修改指定配置项的跳过https请求证书验证选项的值

  hcloud configure set --cli-profile=test --cli-skip-secure-verify=true

注：配置项可以一次修改多个参数，例如同时修改cli-project-id和cli-region，命令如下：

hcloud configure set --cli-profile=test --cli-project-id=0681194*******************f89d2e --cli-region=ap-southeast-1