KooCLI系统参数包括哪些?
系统参数
KooCLI系统参数是指其内置参数,各系统参数的描述信息及其使用方式如下表所示:
参数 |
参数描述 |
使用方式 |
---|---|---|
help |
打印帮助信息 |
命令中直接使用 |
debug |
打印调试信息 |
命令中直接使用 |
dryrun |
执行校验后打印请求报文,跳过实际运行 |
命令中直接使用 |
interactive |
进入交互式模式 |
命令中直接使用 |
cli-region |
区域 |
配置于配置项后使用 / 命令中直接使用 |
cli-access-key |
AK/SK模式时需要的参数Access Key ID |
配置于配置项后使用 / 命令中直接使用 |
cli-secret-key |
AK/SK模式时需要的参数Secret Access Key |
配置于配置项后使用 / 命令中直接使用 |
cli-domain-id |
账号ID |
配置于配置项后使用 / 命令中直接使用 |
cli-project-id |
项目ID |
配置于配置项后使用 / 命令中直接使用 |
cli-profile |
指定配置项,缺省时使用默认配置项 |
配置于配置项后使用 / 命令中直接使用 |
cli-mode |
认证模式[AKSK|ecsAgency] |
配置于配置项后使用 / 命令中直接使用 |
cli-jsonInput |
通过JSON文件方式传入API参数 |
命令中直接使用 |
cli-output |
响应数据的输出格式[json|table|tsv] |
命令中直接使用 |
cli-query |
筛选响应数据的JMESPath路径 |
命令中直接使用 |
cli-output-num |
table输出时,是否打印表格的行号。取值为true或false,默认为true |
命令中直接使用 |
cli-endpoint |
自定义请求域名 |
命令中直接使用 |
cli-connect-timeout |
请求连接超时时间(秒),默认值5秒,参数最小取值为1秒 |
配置于配置项后使用 / 命令中直接使用 |
cli-read-timeout |
I/O超时时间(秒),默认值10秒,参数最小取值为1秒 |
配置于配置项后使用 / 命令中直接使用 |
cli-retry-count |
请求连接重试次数,默认取值为0次,参数取值范围为0~5次 |
配置于配置项后使用 / 命令中直接使用 |
cli-security-token |
用户获取的临时token,必须和临时AK/SK同时使用 |
配置于配置项后使用 / 命令中直接使用 |
cli-lang |
语言,取值为cn或en |
配置于配置项后使用 |
cli-offline |
是否使用离线模式。取值为true或false,默认为true |
配置于配置项后使用 |
cli-skip-secure-verify |
是否跳过https请求证书验证(不建议)。取值为true或false,默认为false |
配置于配置项后使用 / 命令中直接使用 |
cli-agree-privacy-statement |
是否同意隐私。取值为true或false,默认为false |
配置于配置项后使用 |
cli-warning |
是否提示命令执行过程中的Warning信息。取值为true或false,默认为true |
配置于配置项后使用 |
对上表中所列的各参数使用方式解释如下:
- 仅支持配置于配置项后使用:
指该参数只可以通过“hcloud configure set --key1=value1 --key2=value2 ...”命令配置到配置项后再使用。使用时在命令中通过“--cli-profile=${profileName}”指定配置项名称,KooCLI即会在运行过程中解析并使用该配置项中配置的各项参数值。
若在命令中直接使用该类参数,会提示如下错误:
[USE_ERROR]不正确的参数:*
- 仅支持命令中直接使用:
指该参数只可以通过“--key1=value1 --key2=value2 ...”直接在命令中使用。
若将该类参数配置到配置项中,会提示如下错误:
[USE_ERROR]不正确的参数:*
- 配置于配置项后使用 / 命令中直接使用:
指该类参数既可以通过“hcloud configure set --key1=value1 --key2=value2 ...”命令配置到配置项后再使用,也可以通过“--key1=value1 --key2=value2 ...”直接在命令中使用。对于同一参数,KooCLI会在运行过程中优先使用命令中指定的该参数值。未在命令中指定的参数,则使用当前配置项中其值。
与新系统参数相关的KooCLI旧系统参数参见下表。