检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
请确保PATH系统变量值中存在“/usr/local/bin/”路径): mv $(pwd)/hcloud /usr/local/bin/ (可选)执行如下命令,开启自动补全功能。 hcloud auto-complete on 系统显示如下信息表示自动补全功能开启成功。若该配置未生效请按提示执行“bash”命令。
PATH系统变量值中存在“/usr/local/bin/”路径): mv $(pwd)/hcloud /usr/local/bin/ (可选)执行如下命令,开启KooCLI自动补全功能。 hcloud auto-complete on 系统显示如下信息表示自动补全功能开启成功。若
需要视参数value的具体内容而定。 一般情况下,命令中的服务名、operation、参数的value值可不必使用双引号引起。但若您命令中的服务名、operation、参数的value值中有特殊符号、空格、或需要转义的符号,请您在命令中传入该值时,将其使用双引号引起。 您可通过直接在API
P请求异常,请检查网络连接; [CLI_ERROR]:一般是因KooCLI处理命令过程中本身的异常导致的错误,请联系KooCLI的oncall协助处理; [USE_ERROR]:一般是因命令中参数不正确造成的错误,请根据错误提示做相应修改; [OPENAPI_ERROR]:一般是
选中待补全内容后,使用空格键将已选内容追加到当前命令中。 进入交互模式后,使用“Ctrl+C”可切换至新命令行,使用“Ctrl+D”可退出交互模式。 交互式可提示和补全如下内容: 云服务 初次进入交互模式后,会自动提示云服务及系统命令列表。 图1 交互式中提示云服务和系统命令列表 所提示的云服务列表中,左列展示云服务
通过KooCLI调用云服务API。 输入完整的API调用命令后回车,即完成调用。 (可选)将KooCLI命令集成到您的自定义脚本中,实现云服务资源的自动化管理。
在调用云服务API的过程中,KooCLI会对您输入参数的合法性进行校验。在此校验过程中,KooCLI会获取该API中所有参数的详情信息,其中包括每个参数的类型、在request中的位置等信息。若您本地缓存的元数据文件被修改,可能会使KooCLI在运行过程中无法根据缓存文件正确解析
以无配置方式AKSK调用云服务API KooCLI支持在命令中添加“--cli-access-key”,“--cli-secret-key”和“--cli-security-token”选项,以无配置方式AKSK调用云服务API。 当命令中仅使用“--cli-access-key”和“--
源时,会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数,提高响应速度,KooCLI引入了缓存机制,在运行过程中将云服务及其API的相关信息保存在本地缓存文件中,该文件称为元数据缓存文件。在元数据缓存文件过期前,会使用该文件中的信息对命令中的参数进行校验和组装。
元数据缓存文件不会自动更新,故不会因元数据文件内容修改,导致已有命令中参数校验不通过而报错。可保证KooCLI命令一旦构建,长期可用。适用于用户以KooCLI命令构建固定脚本并定期执行,管理云服务和云资源的场景。 在线模式适用场景 会在KooCLI命令执行过程中获取元数据并缓存在
cli-region列表,修改命令中的cli-region值,重新调用; 命令中未指定cli-region值,KooCLI会在运行过程中解析并使用当前配置项中的cli-region值。您可根据错误提示中支持的cli-region列表,在当前命令中添加“--cli-region=$
提示不支持的operation时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误,或该API未在KooCLI上线,会提示如下错误: [USE_ERROR]不支持的operation: * 解决步骤
"body": {} } 根据原始JSON文件中的Key的顺序填充其对应位置的参数: 对于非body位置的参数,请在原始JSON文件对应Key的大括号中,以"参数名称":"参数值"的格式成对填入各参数及其值,同一大括号中每对数据之间以","隔开,最后一对数据与“}”之间不需要再加"
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API:
询,方便提炼原返回结果中的关键信息;“--cli-output”指定响应数据的输出格式;“--cli-output-num”指定当使用table格式输出时,是否打印行号。 输出顺序 使用“--cli-query”指定的JMESPath表达式不同,输出的结果中各参数的排列顺序可能不
针对不同的环境,您可以参考如下方式完成快速安装: 在Windows系统上安装KooCLI 在Linux系统上安装KooCLI 在MacOS系统上安装KooCLI 在Docker中配置和使用KooCLI 您也可以从下表中直接下载适配您目标系统的KooCLI到本地,再将其上传至您的目标机器,解压后即可使用: 表1 下载地址
使用KooCLI调用部分云服务的API时,API的返回结果为空,CLI不会打印相应返回体,用户无法确认是否调用成功。 解决步骤 在原命令中添加“--debug”参数,可打印命令调用过程中的调试信息。其中包含一行内容为“API response status code is xxx.”。用户可以根据该返回体的状态码判断命令是否成功调用。
使用cli-jsonInput的场景有哪些? 云服务的API参数名称中带有“.”,KooCLI可能无法正确解析该参数,此时需通过cli-jsonInput传入该API的参数; 云服务的API在不同位置中有同名的参数时,KooCLI无法正确解析该API的参数,此时需通过cli-jsonInput传入该API的参数;
初始化配置信息时,配置项的名称为“default”,且初始化时配置项中只允许配置永久AK/SK。如果您要使用其他认证方式,或修改初始化的配置项中的参数值,可使用“hcloud configure set --cli-profile=default --key1=value1...”命令,详情请参考新增或修改配置项。
图1为KooCLI大致的入门流程,本入门指导旨在帮助您对其操作有初步的认识。 图1 入门流程 注册华为帐号,创建IAM用户并授权,获取访问密钥等,请参见步骤一:准备工作。 使用KooCLI调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源前,需要先下载对应操作系统的KooCLI,请参见步骤二:快速安装。