检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
提示不支持的参数位置/类型时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源,在调用云服务API的过程中,KooCLI会对您输入参数的合法性进行校验。在此校验过程中,KooCLI会获取该API中所有参数的详情信息,其中包括每个参数的类型、在request中的位置等信
指定配置项 KooCLI支持多配置项,用户可将常用的AK/SK,区域等信息保存到配置项中,使用时通过“--cli-profile”指定目标配置项的名称即可。如下: hcloud EVS ListSnapshots --cli-profile=test 父主题: 选项说明
初始化配置 KooCLI初始化命令用于将常用的永久AK/SK和区域信息存储在配置文件中,避免执行操作时频繁输入这些固定信息。可通过如下命令初始化配置: hcloud configure init 输入以上命令并按回车后,会逐步提示您输入Access Key ID(必填)、Secret
Access Key”的值需要二次确认。为保障您的账号安全,对您输入的“Secret Access Key”进行了匿名化处理。在您输入过程中不会显示输入的字符,在输入结束回车至下一行时,会以“*”回显您的输入内容。在配置完成后,KooCLI会在本地加密保存配置项中的认证相关的敏感信息。 如
} 以table输出调用结果时,“--cli-output-rows”指定json结构体的层级,即表格的数据来源;“--cli-output-cols”指定表格的列名,需要与json结构体中的字段相对应;“--cli-output-num”指定是否打印表格行号,默认值为true,如下图所示:
日志管理 KooCLI提供日志记录和管理功能,会缓存API调用过程中产生的日志信息,日志文件保存目录如下: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\log\ Linux系统: /home/{当前用户名}/.hcloud/log/ Mac系统:
本节以Windows系统为例介绍KooCLI的使用,Linux和MacOS系统的使用基本相同,可参考。 KooCLI最基础的入门操作包括:快速安装、初始化配置信息,查看与执行云服务操作命令。 图1为KooCLI大致的入门流程,本入门指导旨在帮助您对其操作有初步的认识。 图1 入门流程 注册华为
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
数查看帮助信息,例如: hcloud --help 查看KooCLI的使用方法及支持的云服务列表。 hcloud <service> --help 查看指定云服务的operation列表。例如查看“ECS”服务的operation列表:hcloud ECS --help hcloud
隐私声明 详见《隐私政策声明》。 KooCLI的3.2.8及以后的版本在首次使用时,请您根据交互提示信息,选择是否同意其互联网连接及隐私政策声明。 对于不方便交互的场景,如以自动化脚本执行KooCLI命令,可通过如下命令,配置同意隐私声明: hcloud configure set
风险防范 我们强烈建议您: 在.hcloud目录及其子目录和文件上配置适当的文件系统权限,仅限授权用户访问。 在使用敏感变量时对变量值进行加密,以防止敏感信息泄露。 尽可能使用临时认证凭据以降低认证凭据泄露时带来的风险。 父主题: 安全
使用? 通过KooCLI调用云服务API,默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询,方便提炼其中的关键信息,如下: 以默认的json格式输出原调用结果: hcloud ECS NovaListServers
方式输出所有配置项中的accessKeyId信息; “--cli-output-rows”的参数值中可使用“[n]”或“[m:n]”指定其中要打印的数组元素的索引位。指定“[n]”时会打印索引为n的值;指定“[m:n]”时会打印原数据m ~(n-1)索引位置的值。例如执行命令“hcloud
日志文件存于何处? KooCLI会记录您使用过程中产生的日志信息。日志记录功能暂不支持关闭。 日志文件名称为“hcloud.log”,日志文件的存放位置如下: Linux系统:/home/{当前用户名}/.hcloud/log/ Windows系统:C:\Users\{当前用户名}\
如何指定云服务的API和版本号? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。若您当前调用的云服务是多版本服务,即意味着该服务中的部分或全部API有多个版本。因同一API不同版本的参数、使用场景等可能存在差异,故须获取多版本服务API的版本信息。 云服务API的版本查询与指定
使用“--cli-query”指定的JMESPath表达式不同,输出的结果中各参数的排列顺序可能不同。部分表达式的输出结果不会带有输出数据的属性名(即参数的key值),故用户需对输出数据的顺序有所把握,以便于数据处理。不同类型的JMESPath表达式,输出结果的顺序如下表所示: 表1 不同JMESPath表达式的数据输出顺序
云服务API的响应体为空时,如何判断命令是否执行成功? 问题背景 使用KooCLI调用部分云服务的API时,API的返回结果为空,CLI不会打印相应返回体,用户无法确认是否调用成功。 解决步骤 在原命令中添加“--debug”参数,可打印命令调用过程中的调试信息。其中包含一行内容为“API
-num在使用时的注意事项有哪些? 新输出参数的使用方法请参考:指定结果的输出格式。 命令中使用“--cli-query”用于传入JMESPath表达式,对结果执行JMESPath查询,方便提炼原返回结果中的关键信息;“--cli-output”用于指定响应数据的输出格式;“--
"instances": [], "total_count": 0 } 需要注意的是,因为使用“--cli-retry-count”设置重试次数可能会导致调用接口幂等性的问题,有重复调用的风险。对于创建类的接口,请您谨慎使用。 父主题: 选项说明
[CLI_ERROR]:一般是因KooCLI处理命令过程中本身的异常导致的错误,请联系KooCLI的oncall协助处理; [USE_ERROR]:一般是因命令中参数不正确造成的错误,请根据错误提示做相应修改; [OPENAPI_ERROR]:一般是调用云服务API时发生的错误,请联系相关云服务oncall协助处理;