检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在API Explorer上获取CLI示例 API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explorer
以无配置方式AKSK调用云服务API KooCLI支持在命令中添加“--cli-access-key”,“--cli-secret-key”和“--cli-security-token”选项,以无配置方式AKSK调用云服务API。 当命令中仅使用“--cli-access-key”
云服务API相关 提示不支持的operation时如何处理? 如何指定云服务的API和版本号? 云服务API的响应体为空时,如何判断命令是否执行成功?
如何解决网络连接超时问题? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验,此校验过程可能需要远程获取该云服务和API的详情信息;在参数校验完成后,亦需要远程调用您的目标API。如在调用过程中因网络连接问题导致请求失败,会提示相关错误,例如: [NETWORK_ERROR
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API
以JSON文件的方式传递API参数 KooCLI调用云服务的API时,如果API的参数过多,不便直接在命令中传入,用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数,例如KooCLI系统参数、未通过JSON文件传入的云服务
如何指定云服务的API和版本号? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。若您当前调用的云服务是多版本服务,即意味着该服务中的部分或全部API有多个版本。因同一API不同版本的参数、使用场景等可能存在差异,故须获取多版本服务API的版本信息。
云服务API的body位置参数值如何置空? 对于云服务API的body位置的参数,KooCLI支持在任意层级置空: 若当前层级的值实际类型为map,则置空时参数值应为“{}”。 若当前层级的值实际类型为数组,则置空时参数值应为“[]”。 以云服务“ECS”的operation“BatchStopServers
云服务API的响应体为空时,如何判断命令是否执行成功? 问题背景 使用KooCLI调用部分云服务的API时,API的返回结果为空,CLI不会打印相应返回体,用户无法确认是否调用成功。 解决步骤 在原命令中添加“--debug”参数,可打印命令调用过程中的调试信息。其中包含一行内容为
提示不支持的operation时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误,或该API未在KooCLI上线,会提示如下错误: [USE_ERROR]不支持的operation: * 解决步骤
身份认证与访问控制 KooCLI通过华为云API Gateway对华为云OpenAPI进行调用,其身份认证与访问控制与华为云OpenAPI保持一致。 身份认证 KooCLI的API调用分两种模式,一种是无身份认证的调用,当调用华为云OpenAPI中不需认证的API时用户不需要设置身份认证凭据即可调用
使用cli-jsonInput的场景有哪些? 云服务的API参数名称中带有“.”,KooCLI可能无法正确解析该参数,此时需通过cli-jsonInput传入该API的参数; 云服务的API在不同位置中有同名的参数时,KooCLI无法正确解析该API的参数,此时需通过cli-jsonInput
什么是KooCLI 华为云命令行工具服务(Koo Command Line Interface,KooCLI,原名HCloud CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源
在线体验KooCLI 在线体验功能内嵌于API Explorer页面中,您可以在除IE之外的任意浏览器上在线体验KooCLI,如下图所示,鼠标左键单击“CLI示例”方框中的图标按钮即可启动。 图1 在API Explorer上启动在线体验功能 启动时会自动为您分配一个Linux系统的容器
命令中未指定配置项时默认使用哪个配置项? 问题背景 通过KooCLI管理和使用您的各类云服务资源,在调用云服务的API时,KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项,会使用默认配置项来调用目标API。 若该配置项的内容与目标
步骤四:查看与执行云服务操作命令 本节以Windows系统为例介绍KooCLI的使用,Linux和Mac系统的使用基本相同,可参考。 完成初始化配置后,即可查询KooCLI支持的云服务列表,并执行相关命令。下文以弹性云服务器(ECS)的查询云服务器详情的API为例,说明如何查找与执行命令
提示不支持的cli-region时如何处理? 问题背景 使用KooCLI调用所有云服务的API时,都需要提供合适的cli-region。如果您遇到如下几种情况: 命令中cli-region值输入有误; 命令指定了cli-region值,但目标API不支持该cli-region; 命令中未指定
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
提示不支持的参数位置/类型时如何处理? 问题背景 通过KooCLI管理和使用您的各类云服务资源,在调用云服务API的过程中,KooCLI会对您输入参数的合法性进行校验。在此校验过程中,KooCLI会获取该API中所有参数的详情信息,其中包括每个参数的类型、在request中的位置等信息
KooCLI相关概念 在KooCLI指导中常用到的词语,以下做出详细介绍,方便您的阅读理解。 命令 KooCLI提供的各项操作指令,用于配置工作环境,或者调用云各服务开放的API。 API调用命令格式如下: hcloud [options] <service> <operation