检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
KooCLI只提供了一种通过CLI调用云服务API的方法。在使用KooCLI之前,您需要熟悉该API。KooCLI无法为您提供云服务API的具体使用方面的专业帮助,相关问题请咨询服务oncall。
元数据缓存文件存于何处?如何清理? 通过KooCLI管理和使用您的各类云服务资源时,会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数,提高响应速度,KooCLI引入了缓存机制,在运行过程中将云服务及其API的相关信息保存在本地缓存文件中,该文件称为元数据缓存文件
提示不支持的服务时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中云服务的名称输入有误,或调用的云服务未在KooCLI上线,会提示相关错误: [USE_ERROR]不支持的服务名称:* 解决步骤 如遇如上情形,您可先通过执行“
提示不支持的operation时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误,或该API未在KooCLI上线,会提示如下错误: [USE_ERROR]不支持的operation: * 解决步骤
提示不正确的参数时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源时,在调用云服务API的过程中,会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数,或将只允许配置在配置项中使用的参数在命令直接传入,会提示如下错误: [USE_ERROR]不正确的参数
若在查询结果的“Available Operations”中某operation出现多次,且以“/”拼接了不同的版本号,则调用该API时需要指定其版本信息,方法请参考版本指定。
提示不支持的cli-region时如何处理? 问题背景 使用KooCLI调用所有云服务的API时,都需要提供合适的cli-region。如果您遇到如下几种情况: 命令中cli-region值输入有误; 命令指定了cli-region值,但目标API不支持该cli-region; 命令中未指定
KooCLI系统参数包括哪些? 系统参数 KooCLI系统参数是指其内置参数,各系统参数的描述信息及其使用方式如下表所示: 表1 KooCLI新系统参数 参数 参数描述 使用方式 help 打印帮助信息 命令中直接使用 debug 打印调试信息 命令中直接使用 dryrun 执行校验后打印请求报文
概述 如果您需要同时在多个区域或多个项目下管理资源,或者同时使用多个账号,可以通过增加配置项的方式,存储多个不同场景的固定信息。已配置多个配置项的情况下,您可在命令中以“--cli-profile”指定要操作或使用的配置项的名称。 KooCLI配置项中可修改的参数如下表所示。 表1
其他 无配置方式使用KooCLI需要注意什么? 命令中服务名、operation、参数的value值是否需要使用双引号引起? 在线/离线模式分别适用什么场景? 如何卸载KooCLI?
为什么会有新旧KooCLI系统参数,如cli-region与region,推荐使用哪个? 问题背景 在KooCLI系统参数列表中,部分参数同时存在两种形式,如“--cli-region”和“--region”。其中,未添加“cli-”前缀的称为旧系统参数;添加了“cli-”前缀的称为新系统参数
选项说明 选项概述 打印帮助信息 打印命令调用过程中的调试信息 生成JSON格式API入参骨架 检查命令正确性 指定区域 以无配置方式AKSK调用云服务API 指定用户所属账号ID 指定配置项 指定配置项的认证模式 指定结果的输出格式 以JSON文件的方式传递API参数 指定请求超时时间
云服务API的body位置参数值如何置空? 对于云服务API的body位置的参数,KooCLI支持在任意层级置空: 若当前层级的值实际类型为map,则置空时参数值应为“{}”。 若当前层级的值实际类型为数组,则置空时参数值应为“[]”。 以云服务“ECS”的operation“BatchStopServers
使用交互式/自动补全需要注意什么? 在bash环境下,使用“hcloud auto-complete on”可开启自动补全,使用自动补全时需注意: 自动补全提示参数时,若提示的参数名中有“[N]”,其含义为索引位,请使用数字代替该字符;若提示的参数名中有“{*}”,其含义为自定义参数名称
检查命令正确性 dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项,执行校验后打印请求报文,跳过实际运行,不调用目标API: hcloud RDS CreateConfiguration --cli-region="cn-north-4" --project_id
选项概述 KooCLI选项是指可以直接在调用API的命令中添加的系统参数,KooCLI支持的选项及其功能如下表所示。其中除“help”,“debug”,“dryrun”,“cli-output”,“cli-query”,“cli-output-num”,“cli-jsonInput
最新动态 本文介绍了KooCLI各特性版本的功能发布和对应的文档动态,欢迎体验。 2024年7月 序号 功能名称 功能描述 阶段 相关文档 1 支持配置SSO登录参数 KooCLI版本:5.3.4 KooCLI支持使用"--cli-sso-account-name","--cli-sso-permission-set-name
KooCLI相关概念 在KooCLI指导中常用到的词语,以下做出详细介绍,方便您的阅读理解。 命令 KooCLI提供的各项操作指令,用于配置工作环境,或者调用云各服务开放的API。 API调用命令格式如下: hcloud [options] <service> <operation
步骤三:初始化配置(可选) 本节以Windows系统为例介绍KooCLI的使用,Linux和Mac系统的使用基本相同,可参考。 如果您希望以无配置方式使用KooCLI,可跳过此步骤;若您希望以非交互方式添加配置项,请参考新增或修改配置项。 KooCLI初始化命令用于将常用的永久AK
在Linux系统上安装KooCLI KooCLI支持Linux AMD 64位 和 ARM 64位操作系统,您可以根据需要选择一键式安装或分步安装。分步安装时请根据您的操作系统选择相应的安装命令。执行如下命令可查看您主机的操作系统: echo $HOSTTYPE 若执行如上命令的输出值是