检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
模板管理 KooCLI提供由多条KooCLI命令组合而成的shell脚本模板,方便用户理清业务逻辑,完成复杂场景下的操作。用户可根据实际需要下载相应的模板,修改后执行即可。 可使用如下命令,进行模板的查看和下载操作。 查询已有模板列表: hcloud template list hcloud
配置HTTP代理 用户在使用KooCLI管理和使用云服务的资源时,可能会因为用户所在公司的内网访问限制,导致调用云服务API失败。此时,用户可使用HTTP代理访问。使用HTTP代理需要配置环境变量http_proxy和https_proxy。 配置http_proxy环境变量 请根据您系统选择并执行如下命令
认证方式优先级 KooCLI在命令解析过程中,依照如下优先级使用其认证方式,完成调用API时的认证流程: 无配置方式AKSK认证: 无配置方式AKSK:命令中直接输入访问密钥(永久AK/SK,即cli-access-key和cli-secret-key)或临时安全凭证(临时AK/SK
配置命令简介 KooCLI配置命令包含初始化配置、配置项的增删改查等,具体命令如下表: 系统命令 功能简介 hcloud configure init 初始化配置 hcloud configure set 新增/修改配置项 hcloud configure sso SSO登录 hcloud
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
日志文件存于何处? KooCLI会记录您使用过程中产生的日志信息。日志记录功能暂不支持关闭。 日志文件名称为“hcloud.log”,日志文件的存放位置如下: Linux系统:/home/{当前用户名}/.hcloud/log/ Windows系统:C:\Users\{当前用户名}
KooCLI系统参数包括哪些? 系统参数 KooCLI系统参数是指其内置参数,各系统参数的描述信息及其使用方式如下表所示: 表1 KooCLI新系统参数 参数 参数描述 使用方式 help 打印帮助信息 命令中直接使用 debug 打印调试信息 命令中直接使用 dryrun 执行校验后打印请求报文
修改已初始化的配置项 KooCLI目前支持在配置项中以如下组合方式配置认证参数:访问密钥(永久AK/SK),临时安全凭证(临时AK/SK和SecurityToken)两种。 其中,临时安全凭证(临时AK/SK和SecurityToken)具有时效性。 初始化配置信息时,配置项的名称为
元数据管理 清理元数据缓存 KooCLI会缓存API调用过程中获取并保存在用户本地的元数据缓存文件,放置在如下目录下: 在线模式: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\metaRepo\ Linux系统: /home/{当前用户名
指定配置项的认证模式 KooCLI的配置项的认证模式取值为AKSK、ecsAgency,推荐使用AKSK。当使用的配置项同时配置了多种认证模式相关的参数,用户可使用“--cli-mode”选项来指定配置项的认证模式: hcloud CCE ListNodes --cluster_id
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API
指定结果的输出格式 命令中使用“--cli-query”传入JMESPath表达式,对结果执行JMESPath查询,方便提炼原返回结果中的关键信息;“--cli-output”指定响应数据的输出格式;“--cli-output-num”指定当使用table格式输出时,是否打印行号。
交互式/自动补全相关 使用交互式/自动补全需要注意什么?
自定义请求域名 cli-endpoint用于自定义请求云服务的域名。KooCLI默认会请求对应区域的目标云服务,您也可以针对该云服务指定Endpoint: hcloud IoTDA UpdateDevice --cli-region="cn-north-4" --description
以JSON文件的方式传递API参数 KooCLI调用云服务的API时,如果API的参数过多,不便直接在命令中传入,用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数,例如KooCLI系统参数、未通过JSON文件传入的云服务
在线/离线模式分别适用什么场景? 查看/切换当前模式 KooCLI支持在线/离线模式。默认为在线模式。添加配置项之后,您可以执行“hcloud configure list --cli-query=offline”命令查看当前是否已使用离线模式。 执行命令“hcloud configure
交互式提示 KooCLI支持功能强大的多平台支持的交互式提示,方便命令构建,在命令中添加“--interactive”参数即可进入交互式提示。交互式中根据用户当前输入的内容,提示云服务名称,API的operation,参数及其描述信息,也提供部分参数值的补全功能。 交互式的使用方式如下
检查命令正确性 dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项,执行校验后打印请求报文,跳过实际运行,不调用目标API: hcloud RDS CreateConfiguration --cli-region="cn-north-4" --project_id
在API Explorer上获取CLI示例 API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explorer
获取永久AK/SK 访问密钥(AK和SK)是IAM的一种认证机制,用于对请求加密签名,确保请求的机密性、完整性和请求双方身份的正确性: AK(Access Key ID):访问密钥ID,是与私有访问密钥关联的唯一标识符。访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK