检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在API Explorer上获取CLI示例 API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explo
在Docker中配置和使用KooCLI 在Docker中配置和使用KooCLI,请遵循如下步骤(以创建Linux系统ubuntu发行版的Docker容器为例): 在按步骤执行之前,请确保您已经安装Docker。有关安装说明,请参阅 Docker 网站。可运行以下命令确认是否安装Docker:
旧输出参数cli-json-filter如何使用? 通过KooCLI调用云服务API,默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询,方便提炼其中的关键信息,如下: 以默认的json格式输出原调用结果:
提示不支持的operation时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误,或该API未在KooCLI上线,会提示如下错误: [USE_ERROR]不支持的operation: * 解决步骤
旧输出参数cli-json-filter使用时的注意事项有哪些? KooCLI支持使用“--cli-json-filter”传入JMESPath表达式,对json结果执行JMESPath查询,提炼其中的关键信息。使用“--cli-json-filter”时需注意: 当命令中使用了
旧输出参数cli-json-filter如何使用,注意事项有哪些? 旧输出参数cli-json-filter如何使用? 旧输出参数cli-json-filter使用时的注意事项有哪些? 父主题: 输出格式相关
命令中服务名、operation、参数的value值是否需要使用双引号引起? 需要视参数value的具体内容而定。 一般情况下,命令中的服务名、operation、参数的value值可不必使用双引号引起。但若您命令中的服务名、operation、参数的value值中有特殊符号、空
新输出参数cli-output,cli-query,cli-output-num在使用时的注意事项有哪些? 新输出参数的使用方法请参考:指定结果的输出格式。 命令中使用“--cli-query”用于传入JMESPath表达式,对结果执行JMESPath查询,方便提炼原返回结果中的
概述 KooCLI将调用命令时出现的错误分为五种类型,在错误提示信息的起始位置声明其具体类型:[NETWORK_ERROR],[CLI_ERROR],[USE_ERROR],[OPENAPI_ERROR]和[APIE_ERROR]。各类错误的定位方法如下: [NETWORK_ER
云服务API的body位置参数值如何置空? 对于云服务API的body位置的参数,KooCLI支持在任意层级置空: 若当前层级的值实际类型为map,则置空时参数值应为“{}”。 若当前层级的值实际类型为数组,则置空时参数值应为“[]”。 以云服务“ECS”的operation“B
查看帮助信息 KooCLI支持在命令中添加“--help”参数查看帮助信息,例如: hcloud --help 查看KooCLI的使用方法及支持的云服务列表。 hcloud <service> --help 查看指定云服务的operation列表。例如查看“ECS”服务的operation列表:hcloud
查询当前版本 查询KooCLI当前版本的命令为: hcloud version hcloud version 当前KooCLI版本:3.2.8 父主题: 常用命令
什么是KooCLI 华为云命令行工具服务(Koo Command Line Interface,KooCLI,原名HCloud CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。
提示重复的参数时如何处理? 问题背景 KooCLI在命令执行过程中会对参数的合法性进行检查,若命令中存在重复参数,视具体场景不同,会提示不同错误,例如: [USE_ERROR]重复的参数:* [USE_ERROR]重复的参数*,如非误输,请以cli-*为key输入其中的KooCLI系统参数
提示不正确的参数时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源时,在调用云服务API的过程中,会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数,或将只允许配置在配置项中使用的参数在命令直接传入,会提示如下错误: [USE_ERROR]不正确的参数:*
日志管理 KooCLI提供日志记录和管理功能,会缓存API调用过程中产生的日志信息,日志文件保存目录如下: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\log\ Linux系统: /home/{当前用户名}/.hcloud/log/ Mac系统:
无配置方式AKSK 访问密钥(永久AK/SK) 用户可以在命令中直接输入永久AK(cli-access-key)和SK(cli-secret-key)调用云服务API: hcloud ECS NovaListServers --cli-region="cn-north-4" --
打印帮助信息 KooCLI支持查看命令的帮助信息,例如查看“RDS”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
结果轮询 cli-waiter用于结果轮询,参数应为JSON格式且使用双引号包裹。您可以使用此参数进行结果轮询: hcloud ECS NovaShowServer --cli-region="cn-north-4" --server_id="e6b99563-xxxx-xxxx-xxxx-1820d4fd2a6"
KooCLI相关概念 在KooCLI指导中常用到的词语,以下做出详细介绍,方便您的阅读理解。 命令 KooCLI提供的各项操作指令,用于配置工作环境,或者调用云各服务开放的API。 API调用命令格式如下: hcloud [options] <service> <operation>