检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
提示不支持的参数位置/类型时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源,在调用云服务API的过程中,KooCLI会对您输入参数的合法性进行校验。在此校验过程中,KooCLI会获取该API中所有参数的详情信息,其中包括每个参数的类型、在request中的位置
打印帮助信息 KooCLI支持查看命令的帮助信息,例如查看“RDS”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
KooCLI相关概念 在KooCLI指导中常用到的词语,以下做出详细介绍,方便您的阅读理解。 命令 KooCLI提供的各项操作指令,用于配置工作环境,或者调用云各服务开放的API。 API调用命令格式如下: hcloud [options] <service> <operation>
如何使用KooCLI 下载KooCLI。 KooCLI绿色免安装,下载到本地后解压即可使用。KooCLI支持Windows 64位、Linux AMD 64位、Linux ARM 64位、macOS AMD 64位、macOS ARM 64位,请根据您本地系统下载对应的版本。 配置KooCLI环境。
概述 KooCLI将调用命令时出现的错误分为五种类型,在错误提示信息的起始位置声明其具体类型:[NETWORK_ERROR],[CLI_ERROR],[USE_ERROR],[OPENAPI_ERROR]和[APIE_ERROR]。各类错误的定位方法如下: [NETWORK_ER
检查命令正确性 dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项,执行校验后打印请求报文,跳过实际运行,不调用目标API: hcloud RDS CreateConfiguration --cli-region="cn-north-4" --pro
审计与日志 由于KooCLI是部署在用户本地的客户端工具,工具本身记录的日志可以作为审计目的使用,但是需要用户对日志进行访问权限控制以达到审计日志不可篡改的目的。此外, 同使用SDK一样,KooCLI将用户命令解析成https请求发送到API Gateway后,API Gateway记录的相关信息也可用作审计目的。
提示不正确的参数时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源时,在调用云服务API的过程中,会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数,或将只允许配置在配置项中使用的参数在命令直接传入,会提示如下错误: [USE_ERROR]不正确的参数:*
无配置方式使用概述 KooCLI既可以使用配置项调用云服务API,也提供了无配置的操作方式,无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息,而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项,方便快捷地使用KooCLI。用户可以通过如下认证方式直接调用云服务API:
提示重复的参数时如何处理? 问题背景 KooCLI在命令执行过程中会对参数的合法性进行检查,若命令中存在重复参数,视具体场景不同,会提示不同错误,例如: [USE_ERROR]重复的参数:* [USE_ERROR]重复的参数*,如非误输,请以cli-*为key输入其中的KooCLI系统参数
交互式提示 KooCLI支持功能强大的多平台支持的交互式提示,方便命令构建,在命令中添加“--interactive”参数即可进入交互式提示。交互式中根据用户当前输入的内容,提示云服务名称,API的operation,参数及其描述信息,也提供部分参数值的补全功能。 交互式的使用方式如下:
元数据缓存文件存于何处?如何清理? 通过KooCLI管理和使用您的各类云服务资源时,会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数,提高响应速度,KooCLI引入了缓存机制,在运行过程中将云服务及其API的相关信息保存在本地缓存文件中,该文件称为元数据缓存文
元数据缓存相关 元数据缓存文件存于何处?如何清理?
云服务相关 提示不支持的服务时如何处理?
参数相关 KooCLI系统参数包括哪些? 提示不正确的参数时如何处理? 为什么会有新旧KooCLI系统参数,如cli-region与region,推荐使用哪个? 提示重复的参数时如何处理? 如何使用cli-jsonInput?注意事项有哪些? 使用cli-jsonInput的场景有哪些?
其他 无配置方式使用KooCLI需要注意什么? 命令中服务名、operation、参数的value值是否需要使用双引号引起? 在线/离线模式分别适用什么场景? 如何卸载KooCLI?
交互式/自动补全相关 使用交互式/自动补全需要注意什么?
输出格式相关 KooCLI支持的输出格式有哪些? 如何定义JMESPath表达式 KooCLI与输出相关的系统参数有哪些,推荐使用哪些? 新输出参数cli-output,cli-query,cli-output-num在使用时的注意事项有哪些? 旧输出参数cli-output-r
步骤二:快速安装 概述 在Windows系统上安装KooCLI 在Linux系统上安装KooCLI 在MacOS系统上安装KooCLI 在Docker中配置和使用KooCLI