检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置KooCLI环境。 环境配置请参考快速初始化配置。 获取云服务API调用命令。 获取云服务API调用命令有两种方式： （推荐）API Explorer上获取 云服务的API可在API Explorer上查看。您可以在API Explorer上先填写好各参数的值，即可从“CLI示例”页签中直接获取命令。
身份认证与访问控制 KooCLI通过华为云API Gateway对华为云OpenAPI进行调用，其身份认证与访问控制与华为云OpenAPI保持一致。 身份认证 KooCLI的API调用分两种模式，一种是无身份认证的调用，当调用华为云OpenAPI中不需认证的API时用户不需要设置身份认证凭据即
通过KooCLI管理和使用您的各类云服务资源，在调用云服务的API时，KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项，会使用默认配置项来调用目标API。 若该配置项的内容与目标API不匹配，或缺少访问目标API时需要的某参数，会提示相关错误，例如：
误，请根据错误提示做相应修改； [OPENAPI_ERROR]：一般是调用云服务API时发生的错误，请联系相关云服务oncall协助处理； [APIE_ERROR]：一般是调用API Explorer获取元数据时发生的错误，请联系API Explorer云服务oncall协助处理。
提示不支持的参数位置/类型时如何处理？ 问题背景 通过KooCLI管理和使用您的各类云服务资源，在调用云服务API的过程中，KooCLI会对您输入参数的合法性进行校验。在此校验过程中，KooCLI会获取该API中所有参数的详情信息，其中包括每个参数的类型、在request中的位置
cli-mode 认证模式[AKSK|ecsAgency] 配置于配置项后使用 / 命令中直接使用 cli-jsonInput 通过JSON文件方式传入API参数 命令中直接使用 cli-output 响应数据的输出格式[json|table|tsv] 命令中直接使用 cli-query 筛选响应数据的JMESPath路径
元数据缓存文件存于何处？如何清理？ 通过KooCLI管理和使用您的各类云服务资源时，会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数，提高响应速度，KooCLI引入了缓存机制，在运行过程中将云服务及其API的相关信息保存在本地缓存文件中，该文件称为元数据缓存文件
提示不正确的参数时如何处理？ 问题背景 通过KooCLI管理和使用您的各类云服务资源时，在调用云服务API的过程中，会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数，或将只允许配置在配置项中使用的参数在命令直接传入，会提示如下错误： [USE_ERROR]不正确的参数:*
切换默认配置项。 参数 参数可分为API参数和KooCLI系统参数。API参数是指云服务的API中定义的参数；系统参数是指KooCLI的内置参数，具有其固定的使用方式和特定含义。请查看系统参数列表。 选项 KooCLI选项是指可以直接在调用API的命令中添加的KooCLI系统参数
荐使用哪个？ 提示重复的参数时如何处理？ 如何使用cli-jsonInput？注意事项有哪些？ 使用cli-jsonInput的场景有哪些？ 提示不支持的参数位置/类型时如何处理？ 云服务API的body位置参数值如何置空？
会根据当前API的参数列表自动识别各个参数的用途： 若目标API中存在“region”同名参数，或可自定义参数名称，KooCLI会在命令执行过程中自动将“--cli-region”识别为系统参数，其值用于获取目标API的详情信息；而将“--region”识别为目标API的参数，其值将用于目标API的调用。
临时安全凭证（临时AK/SK和SecurityToken） 用户可以在命令中直接输入临时AK（cli-access-key），SK（cli-secret-key）和SecurityToken（cli-security-token）调用云服务API： hcloud ECS NovaListServers
日志管理 KooCLI提供日志记录和管理功能，会缓存API调用过程中产生的日志信息，日志文件保存目录如下： Windows系统： C:\Users\{您的Windows系统用户名}\.hcloud\log\ Linux系统: /home/{当前用户名}/.hcloud/log/ Mac系统：
eName}”传入JSON文件，向KooCLI传递云服务API参数。KooCLI会在运行时解析并使用该JSON文件中的参数调用目标API。 使用方式 cli-jsonInput的使用方式请参考：以JSON文件的方式传递API参数。 注意事项 “--cli-jsonInput”选项
KooCLI在命令解析过程中，依照如下优先级使用其认证方式，完成调用API时的认证流程： 无配置方式AKSK认证： 无配置方式AKSK：命令中直接输入访问密钥（永久AK/SK，即cli-access-key和cli-secret-key）或临时安全凭证（临时AK/SK和SecurityToken，即cli-a
服务的API列表/该系统命令的子命令（或参数）。 所提示的系统命令列表中，左列展示该系统命令的子命令（或参数），右列展示该子命令（或参数）的描述信息。 图2 交互式中提示云服务的API列表 所提示的云服务API列表中，左列展示API的operation名称，右列展示该API的描述信息。
向用户确认该参数的实际用途，避免解析错误。例如： 目标API中存在与KooCLI系统参数%s同名的参数,无法识别命令中%s的位置.请确认该参数为:KooCLI系统参数(a);目标API参数(b);兼为两者(c): 目标API中可自定义与KooCLI系统参数%s同名的参数,无法识别命令中%s的位置
使用“--cli-json-filter”对原json结果的内容执行JMESPath查询，获取每个servers元素的“id”和“name”，并将其重命名为“EcsID”和“EcsName”，如下示例所示： hcloud ECS NovaListServers --cli-region="cn-north-4"
使用KooCLI调用所有云服务的API时，都需要提供合适的cli-region。如果您遇到如下几种情况： 命令中cli-region值输入有误； 命令指定了cli-region值，但目标API不支持该cli-region； 命令中未指定cli-region值，目标API不支持从当前配置项中获取的cli-region。
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时，需添加账号ID（即cli-domain-id）。KooCLI会在调用全局服务的API的过程中，根据用户认证信息自动获取账号ID，用户也可在命令中添加“--cli-domain-id”选项，如下： hcloud
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
