检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在API Explorer上获取CLI示例 API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explo
云服务API相关 提示不支持的operation时如何处理? 如何指定云服务的API和版本号? 云服务API的响应体为空时,如何判断命令是否执行成功?
云服务API的版本查询与指定 版本查询 您可以通过“hcloud <service> --help”命令,查看该云服务的operation列表。若在查询结果的“Available Operations”中某operation出现多次,且以“/”拼接了不同的版本号,则调用该API时需
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API: hcloud
以JSON文件的方式传递API参数 KooCLI调用云服务的API时,如果API的参数过多,不便直接在命令中传入,用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数,例如KooCLI系统参数、未通过JSON文件传入的云服务API参数等,仍可在命令中传入,例如:
以无配置方式AKSK调用云服务API KooCLI支持在命令中添加“--cli-access-key”,“--cli-secret-key”和“--cli-security-token”选项,以无配置方式AKSK调用云服务API。 当命令中仅使用“--cli-access-key
云服务API的body位置参数值如何置空? 对于云服务API的body位置的参数,KooCLI支持在任意层级置空: 若当前层级的值实际类型为map,则置空时参数值应为“{}”。 若当前层级的值实际类型为数组,则置空时参数值应为“[]”。 以云服务“ECS”的operation“B
云服务API的响应体为空时,如何判断命令是否执行成功? 问题背景 使用KooCLI调用部分云服务的API时,API的返回结果为空,CLI不会打印相应返回体,用户无法确认是否调用成功。 解决步骤 在原命令中添加“--debug”参数,可打印命令调用过程中的调试信息。其中包含一行内容为“API
查询指定配置项 查询指定配置项中的系统参数 查询指定配置项中的custom参数 父主题: 配置信息管理
提示不支持的operation时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误,或该API未在KooCLI上线,会提示如下错误: [USE_ERROR]不支持的operation: * 解决步骤
查询配置项列表 查询配置项列表中的系统参数 查询配置项列表中的custom参数 父主题: 配置信息管理
步骤四:查看与执行云服务操作命令 本节以Windows系统为例介绍KooCLI的使用,Linux和Mac系统的使用基本相同,可参考。 完成初始化配置后,即可查询KooCLI支持的云服务列表,并执行相关命令。下文以弹性云服务器(ECS)的查询云服务器详情的API为例,说明如何查找与执行命令。
查询当前版本 查询KooCLI当前版本的命令为: hcloud version hcloud version 当前KooCLI版本:3.2.8 父主题: 常用命令
打印帮助信息 KooCLI支持查看命令的帮助信息,例如查看“RDS”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
如何解决网络连接超时问题? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验,此校验过程可能需要远程获取该云服务和API的详情信息;在参数校验完成后,亦需要远程调用您的目标API。如在调用过程中因网络连接问题导致请求失败,会提示相关错误,例如: [NETWORK_ERROR]连接超时
查询指定配置项中的系统参数 使用“--cli-profile”指定要查询的配置项的名称,缺省时查询默认配置项。支持以table,json或tsv格式输出,默认以json格式输出。查看指定配置项中的系统参数的命令为: hcloud configure show [--cli-pro
查看帮助信息 KooCLI支持在命令中添加“--help”参数查看帮助信息,例如: hcloud --help 查看KooCLI的使用方法及支持的云服务列表。 hcloud <service> --help 查看指定云服务的operation列表。例如查看“ECS”服务的operation列表:hcloud
查询指定配置项中的custom参数 使用“--cli-profile”指定要查询的配置项的名称,支持以table,json或tsv格式输出,默认为json格式。查看指定配置项中的custom参数的命令为: hcloud configure show [--cli-profile=${profileName}]
CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 KooCLI只提供了一种通过CLI调用云服务API的方法。在使用KooCLI之前,您需要熟悉该API。KooC
通过KooCLI管理和使用您的各类云服务资源,在调用云服务的API时,KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项,会使用默认配置项来调用目标API。 若该配置项的内容与目标API不匹配,或缺少访问目标API时需要的某参数,会提示相关错误,例如: