检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在API Explorer上获取CLI示例 API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explo
以JSON文件的方式传递API参数 KooCLI调用云服务的API时,如果API的参数过多,不便直接在命令中传入,用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数,例如KooCLI系统参数、未通过JSON文件传入的云服务API参数等,仍可在命令中传入,例如:
云服务API相关 提示不支持的operation时如何处理? 如何指定云服务的API和版本号? 云服务API的响应体为空时,如何判断命令是否执行成功?
expression(用&expression表示的表达式) null 各内置函数支持的数据类型不同。具体如下表。函数参数中一个特殊字符“@”代表将当前结果作为入参传递给函数: 表1 JMESPath表达式支持的内置函数 内置函数 入参数据类型 出参数据类型 用途 内置函数使用示例 abs number number
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API: hcloud
以无配置方式AKSK调用云服务API KooCLI支持在命令中添加“--cli-access-key”,“--cli-secret-key”和“--cli-security-token”选项,以无配置方式AKSK调用云服务API。 当命令中仅使用“--cli-access-key
如何指定云服务的API和版本号? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。若您当前调用的云服务是多版本服务,即意味着该服务中的部分或全部API有多个版本。因同一API不同版本的参数、使用场景等可能存在差异,故须获取多版本服务API的版本信息。 云服务API的版本查询与指定
CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 KooCLI只提供了一种通过CLI调用云服务API的方法。在使用KooCLI之前,您需要熟悉该API。KooC
华为云命令行工具服务(Koo Command Line Interface,KooCLI),是为发布在API Explorer上的华为云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 在线体验 详细文档 仅两个按钮时选用 立即使用
`foo`)将返回true。 使用函数时需要注意以下几点: 函数参数有类型限制。如果函数的参数类型错误,KooCLI会提示错误告警信息并输出原json结果。有些函数可以进行类型转换(to_string、to_number)以帮助将参数转换为正确的类型。 函数参数有个数限制。如果调用函数时入参个数错误
如何定义JMESPath表达式 JMESPath表达式的用法有哪些? JMESPath支持的内置函数有哪些? 父主题: 输出格式相关
使用cli-jsonInput的场景有哪些? 云服务的API参数名称中带有“.”,KooCLI可能无法正确解析该参数,此时需通过cli-jsonInput传入该API的参数; 云服务的API在不同位置中有同名的参数时,KooCLI无法正确解析该API的参数,此时需通过cli-jsonInput传入该API的参数; 用户
云服务API的响应体为空时,如何判断命令是否执行成功? 问题背景 使用KooCLI调用部分云服务的API时,API的返回结果为空,CLI不会打印相应返回体,用户无法确认是否调用成功。 解决步骤 在原命令中添加“--debug”参数,可打印命令调用过程中的调试信息。其中包含一行内容为“API
云服务API的body位置参数值如何置空? 对于云服务API的body位置的参数,KooCLI支持在任意层级置空: 若当前层级的值实际类型为map,则置空时参数值应为“{}”。 若当前层级的值实际类型为数组,则置空时参数值应为“[]”。 以云服务“ECS”的operation“B
身份认证与访问控制 KooCLI通过华为云API Gateway对华为云OpenAPI进行调用,其身份认证与访问控制与华为云OpenAPI保持一致。 身份认证 KooCLI的API调用分两种模式,一种是无身份认证的调用,当调用华为云OpenAPI中不需认证的API时用户不需要设置身份认证凭据即
使用KooCLI调用所有云服务的API时,都需要提供合适的cli-region。如果您遇到如下几种情况: 命令中cli-region值输入有误; 命令指定了cli-region值,但目标API不支持该cli-region; 命令中未指定cli-region值,目标API不支持从当前配置项中获取的cli-region。
误,请根据错误提示做相应修改; [OPENAPI_ERROR]:一般是调用云服务API时发生的错误,请联系相关云服务oncall协助处理; [APIE_ERROR]:一般是调用API Explorer获取元数据时发生的错误,请联系API Explorer云服务oncall协助处理。
提示不支持的operation时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误,或该API未在KooCLI上线,会提示如下错误: [USE_ERROR]不支持的operation: * 解决步骤
元数据缓存文件存于何处?如何清理? 通过KooCLI管理和使用您的各类云服务资源时,会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数,提高响应速度,KooCLI引入了缓存机制,在运行过程中将云服务及其API的相关信息保存在本地缓存文件中,该文件称为元数据缓存文件。在元数据缓存文件过期前,会使
通过KooCLI管理和使用您的各类云服务资源,在调用云服务的API时,KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项,会使用默认配置项来调用目标API。 若该配置项的内容与目标API不匹配,或缺少访问目标API时需要的某参数,会提示相关错误,例如: