检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
交互式中根据用户当前输入的内容,提示云服务名称,API的operation,参数及其描述信息,也提供部分参数值的补全功能。 交互式的使用方式如下: 交互模式中使用“Tab”或向上箭头、向下箭头键实现待补全内容的上下选择。 选中待补全内容后,使用空格键将已选内容追加到当前命令中。
创建临时容器,向容器共享宿主机环境变量(以Linux系统的宿主机为例),执行命令: 通过“-e”标志共享宿主机的环境变量到容器中: docker run --rm -it -e ${envName} hcloudcli ${command} 给命令起别名(以Linux系统的宿主机为例),以简化命令。以使用追加了“ENTRYPOINT
若不存在,请您检查是否误输。若存在(此种冲突的情况出现的概率极小),请您将命令中的API参数写入cli-jsonInput文件中,以JSON文件的方式传递API参数。 父主题: 参数相关
n结构体的名称时,各层级之间以“.”分隔,目标json结构体的内容必须为数组类型,KooCLI会将该json结构体的内容以表格化输出。例如执行命令“hcloud configure list --cli-output-rows=profiles”,会以表格输出所有配置项信息。若“
打印命令调用过程中的调试信息 生成JSON格式API入参骨架 检查命令正确性 指定区域 以无配置方式AKSK调用云服务API 指定用户所属账号ID 指定配置项 指定配置项的认证模式 指定结果的输出格式 以JSON文件的方式传递API参数 指定请求超时时间 指定请求连接重试次数 跳过https请求证书验证
CLI传递云服务API参数。KooCLI会在运行时解析并使用该JSON文件中的参数调用目标API。 使用方式 cli-jsonInput的使用方式请参考:以JSON文件的方式传递API参数。 注意事项 “--cli-jsonInput”选项传入的JSON文件中目前只支持写入云服务
--cli-warning=false"配置关闭Warning提示信息。可以避免以自动化脚本执行命令时,输出的Warning提示信息干扰命令执行结果的解析。 商用 配置关闭Warning提示信息 2023年2月 序号 功能名称 功能描述 阶段 相关文档 1 支持以非交互的方式,配置是否同意隐私声明 KooCLI版本:4
认证相关 如何获取永久AK/SK? 如何获取账号ID、项目ID? 如何获取区域? 如何获取临时AK/SK和securitytoken? 各认证方式的优先级是什么? 配置项相关 命令中未指定配置项时默认使用哪个配置项? 元数据缓存相关 元数据缓存文件存于何处?如何清理? 日志相关 日志文件存于何处?
入门流程 本节以Windows系统为例介绍KooCLI的使用,Linux和MacOS系统的使用基本相同,可参考。 KooCLI最基础的入门操作包括:快速安装、初始化配置信息,查看与执行云服务操作命令。 图1为KooCLI大致的入门流程,本入门指导旨在帮助您对其操作有初步的认识。 图1
查询配置项列表中的系统参数 KooCLI支持多配置项,查询配置项列表中的系统参数的命令如下,查询结果支持以table,json或tsv格式输出,默认以json格式输出: hcloud configure list hcloud configure list { "localDea":
其他 无配置方式使用KooCLI需要注意什么? 命令中服务名、operation、参数的value值是否需要使用双引号引起? 在线/离线模式分别适用什么场景? 如何卸载KooCLI?
如您网络连接确认无异常,错误信息中提示您“连接超时”,可能是配置项或命令中的cli-connect-timeout的值过小,您可以通过如下方式修改该值: 若您已在命令中使用“--cli-connect-timeout”选项,请适当增大其值,重新调用; 如您未在命令中使用“--cl
--help”命令,查看该云服务的operation列表。若在查询结果的“Available Operations”中某operation出现多次,且以“/”拼接了不同的版本号,则调用该API时需要指定其版本信息,方法请参考版本指定。其余在该云服务operation列表中只出现了一次的ope
步骤四:查看与执行云服务操作命令 本节以Windows系统为例介绍KooCLI的使用,Linux和Mac系统的使用基本相同,可参考。 完成初始化配置后,即可查询KooCLI支持的云服务列表,并执行相关命令。下文以弹性云服务器(ECS)的查询云服务器详情的API为例,说明如何查找与执行命令。
认证相关 获取认证信息 认证方式优先级
用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询,方便提炼其中的关键信息,如下: 以默认的json格式输出原调用结果: hcloud ECS NovaListServers --cli-region="cn-north-4"
查询配置项列表中的custom参数 查询KooCLI配置项列表中的custom参数的命令如下,查询结果支持以table,json或tsv格式输出,默认以json格式输出: hcloud configure list --cli-custom=true hcloud configure
任意层级置空: 若当前层级的值实际类型为map,则置空时参数值应为“{}”。 若当前层级的值实际类型为数组,则置空时参数值应为“[]”。 以云服务“ECS”的operation“BatchStopServers”为例,其body位置存在参数“os-stop.servers.[N]
检查命令正确性 指定输出格式 指定JSON文件传递API参数 指定请求超时时间 请求连接重试次数 跳过https请求证书验证 自定义请求域名 无配置方式使用KooCLI 命令构建 在API Explorer上获取CLI示例 自动补全 交互式提示 常见问题 了解更多常见问题、案例和解决方案 热门案例
"values": { "max_connections": "10" } } } 将该文件传入命令中,以--cli-jsonInput方式调用API: hcloud RDS CreateConfiguration --cli-region="cn-north-4"