检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
一：准备工作。 使用KooCLI调用API Explorer中各云服务开放的API，管理和使用您的各类云服务资源前，需要先下载对应操作系统的KooCLI，请参见步骤二：快速安装。 使用KooCLI时，需要获取调用者的身份信息用以认证鉴权。如您不是以无配置方式使用，那么您需要先配置
查询指定配置项中的custom参数 使用“--cli-profile”指定要查询的配置项的名称，支持以table，json或tsv格式输出，默认为json格式。查看指定配置项中的custom参数的命令为： hcloud configure show [--cli-profile=${profileName}]
输出顺序 使用“--cli-query”指定的JMESPath表达式不同，输出的结果中各参数的排列顺序可能不同。部分表达式的输出结果不会带有输出数据的属性名（即参数的key值），故用户需对输出数据的顺序有所把握，以便于数据处理。不同类型的JMESPath表达式，输出结果的顺序如下表所示：
步骤四：查看与执行云服务操作命令 本节以Windows系统为例介绍KooCLI的使用，Linux和Mac系统的使用基本相同，可参考。 完成初始化配置后，即可查询KooCLI支持的云服务列表，并执行相关命令。下文以弹性云服务器（ECS）的查询云服务器详情的API为例，说明如何查找与执行命令。
指定配置项的认证模式 KooCLI的配置项的认证模式取值为AKSK、ecsAgency，推荐使用AKSK。当使用的配置项同时配置了多种认证模式相关的参数，用户可使用“--cli-mode”选项来指定配置项的认证模式： hcloud CCE ListNodes --cluster_
风险防范 我们强烈建议您： 在.hcloud目录及其子目录和文件上配置适当的文件系统权限，仅限授权用户访问。 在使用敏感变量时对变量值进行加密，以防止敏感信息泄露。 尽可能使用临时认证凭据以降低认证凭据泄露时带来的风险。 父主题： 安全
选项概述 打印帮助信息 打印命令调用过程中的调试信息 生成JSON格式API入参骨架 检查命令正确性 指定区域 以无配置方式AKSK调用云服务API 指定用户所属账号ID 指定配置项 指定配置项的认证模式 指定结果的输出格式 以JSON文件的方式传递API参数 指定请求超时时间 指定请求连接重试次数
数查看帮助信息，例如： hcloud --help 查看KooCLI的使用方法及支持的云服务列表。 hcloud <service> --help 查看指定云服务的operation列表。例如查看“ECS”服务的operation列表：hcloud ECS --help hcloud
如果您需要同时在多个区域或多个项目下管理资源，或者同时使用多个账号，可以通过增加配置项的方式，存储多个不同场景的固定信息。已配置多个配置项的情况下，您可在命令中以“--cli-profile”指定要操作或使用的配置项的名称。 KooCLI配置项中可修改的参数如下表所示。 表1 配置项参数 参数名
若未生效请执行`bash`命令 自动补全功能仅支持bash。 自动补全提示参数时，若提示的参数名中有“[N]”，其含义为索引位，请使用数字代替该字符；若提示的参数名中有“{*}”，其含义为自定义参数名称，请使用任意不含“.”的字符串代替该字符； 父主题： 常用命令
Gateway之间的通信传输采用https协议，有效防止数据被篡改，保护用户数据在网络中的传输安全。加密协议为业界公认安全性较高的TLS1.2、TLS1.3。 敏感数据保护 用户使用KooCLI配置的认证凭据（如AK/SK）、自定义变量支持加密方式存储。 KooCLI的加密密钥在首次
] } 其中，敏感参数的值会被匿名化展示。 可以使用“--cli-query”对查询结果进行过滤。使用“--cli-query”时，默认以json格式输出，可同时使用“--cli-output”指定输出格式。例如以json格式输出，筛选每个配置项中的AK/SK： hcloud
--cli-retry-count=3 需要注意的是，因为使用“--cli-retry-count”设置重试次数可能会导致调用接口幂等性的问题，有重复调用的风险。对于创建类的接口，请您谨慎使用。 修改指定配置项的跳过https请求证书验证选项的值 hcloud configure set
指定配置项 KooCLI支持多配置项，用户可将常用的AK/SK，区域等信息保存到配置项中，使用时通过“--cli-profile”指定目标配置项的名称即可。如下： hcloud EVS ListSnapshots --cli-profile=test 父主题： 选项说明
KooCLI支持的输出格式有哪些？ KooCLI支持三种输出格式：json，table，tsv。默认以json格式输出。您可以使用“--cli-output”参数指定如前所述的任意一种输出格式，您也可以配合使用“--cli-query”选项传入JMESPath表达式，对json结
提示缺少cli-region参数时如何处理？ 问题背景 使用KooCLI调用所有云服务的API时，都需要指定区域（即cli-region）。如果您未在命令中指定cli-region值，且您当前使用的配置项中也未配置cli-region值，会提示如下错误： [USE_ERROR]请输入cli-region
通过KooCLI管理和使用您的各类云服务资源时，会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数，提高响应速度，KooCLI引入了缓存机制，在运行过程中将云服务及其API的相关信息保存在本地缓存文件中，该文件称为元数据缓存文件。在元数据缓存文件过期前，会使用该文件中的信息对命令中的参数进行校验和组装。
其中，加密保存的custom参数值会被匿名化展示。 可以使用“--cli-query”对查询结果进行过滤，使用“--cli-query”时，默认以json格式输出，可同时使用“--cli-output”指定输出格式。例如以json格式输出，查询名称为test的配置项的所有custom参数：
在线体验 在线体验KooCLI 在线体验功能特性
认证相关 获取认证信息 认证方式优先级
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
