检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API Explorer上开放的各云服务API，除了支持在线调试，还能生成KooCLI命令示例（以下简称CLI示例）。您在API Explorer界面上填写API参数，在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explorer上CDN服务的创建加速域名API。在API
Explorer页面中，您可以在除IE之外的任意浏览器上在线体验KooCLI，如下图所示，鼠标左键单击“CLI示例”方框中的图标按钮即可启动。 图1 在API Explorer上启动在线体验功能 启动时会自动为您分配一个Linux系统的容器（以下称之为实例）供您使用，该实例上已预装最新版的KooCLI。在线体验功能具有以下优点：
KooCLI以AKSK模式调用全局服务的API时，需添加账号ID（即cli-domain-id）。KooCLI会在调用全局服务的API的过程中，根据用户认证信息自动获取账号ID，用户也可在命令中添加“--cli-domain-id”选项，如下： hcloud CDN ListDomains
通过KooCLI管理和使用您的各类云服务资源时，会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数，提高响应速度，KooCLI引入了缓存机制，在运行过程中将云服务及其API的相关信息保存在本地缓存文件中，该文件称为元数据缓存文件。在元数据缓存文件过期前，会使用该文件中的信息对命令中的参数进行校验和组装。
cli-domain-id 选项 IAM用户所属账号ID。以AKSK认证模式调用全局服务的API时需要。一般情况下，调用全局服务的API时，KooCLI会根据用户的认证信息自动获取此参数的值。 hcloud CDN ListDomains --cli-region="cn-north-1"
提示不支持的operation时如何处理？ 问题背景 KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验。如果您命令中API的operation输入有误，或该API未在KooCLI上线，会提示如下错误： [USE_ERROR]不支持的operation: * 解决步骤
提示不正确的参数时如何处理？ 问题背景 通过KooCLI管理和使用您的各类云服务资源时，在调用云服务API的过程中，会对您输入参数的合法性进行校验。若您在命令中输入了当前API不支持的参数，或将只允许配置在配置项中使用的参数在命令直接传入，会提示如下错误： [USE_ERROR]不正确的参数:*
如何指定云服务的API和版本号？ 问题背景 KooCLI调用云服务API的过程中，会对您输入参数的合法性进行校验。若您当前调用的云服务是多版本服务，即意味着该服务中的部分或全部API有多个版本。因同一API不同版本的参数、使用场景等可能存在差异，故须获取多版本服务API的版本信息。 云服务API的版本查询与指定
I的参数列表，确认目标API中是否存在该参数，或存在可自定义参数名称的参数（即名称为“{*}”的参数）。若不存在，请您检查是否误输。若存在（此种冲突的情况出现的概率极小），请您将命令中的API参数写入cli-jsonInput文件中，以JSON文件的方式传递API参数。 父主题：
打印命令调用过程中的调试信息 KooCLI支持打印命令执行过程中的调试信息。在命令中添加“--debug”即可： hcloud VPC ShowVpc/v3 --cli-region="cn-north-4" --project_id="0dd8cb****************19b5a84546"
此，请参考下图，在项目列表中找到您的服务器资源对应的所属区域，在其左侧获取对应区域的项目ID，单击其左侧的图标可获取对应区域下的子项目ID。 图1 账号ID、项目ID KooCLI可在API调用过程中， 根据当前用户认证信息自行获取请求头中需要的账号ID、项目ID，因此命令中可不输入该参数。
云服务API的body位置参数值如何置空？ 对于云服务API的body位置的参数，KooCLI支持在任意层级置空： 若当前层级的值实际类型为map，则置空时参数值应为“{}”。 若当前层级的值实际类型为数组，则置空时参数值应为“[]”。 以云服务“ECS”的operation“B
参数可分为API参数和KooCLI系统参数。API参数是指云服务的API中定义的参数；系统参数是指KooCLI的内置参数，具有其固定的使用方式和特定含义。请查看系统参数列表。 选项 KooCLI选项是指可以直接在调用API的命令中添加的KooCLI系统参数，并非所有的系统参数都可作为选项使用。请查看选项列表。
--help 查看KooCLI的使用方法及支持的云服务列表。 hcloud <service> --help 查看指定云服务的operation列表。例如查看“ECS”服务的operation列表：hcloud ECS --help hcloud <service> <operation>
本节以Windows系统为例介绍KooCLI的使用，Linux和Mac系统的使用基本相同，可参考。 完成初始化配置后，即可查询KooCLI支持的云服务列表，并执行相关命令。下文以弹性云服务器（ECS）的查询云服务器详情的API为例，说明如何查找与执行命令。 查询云服务的operation列表 hcloud
[-i=xxx] [-k=xxx] [-t=xxx] stat 查询桶属性 查询单个桶的基本属性，包括桶的默认存储类型、桶的区域、桶的版本号、桶是否支持文件接口、桶的可用区、桶中对象数量、桶的存储用量以及桶的配额。 hcloud obs stat obs://bucket [-acl] [-bf=xxx]
修改已初始化的配置项 KooCLI目前支持在配置项中以如下组合方式配置认证参数：访问密钥（永久AK/SK），临时安全凭证（临时AK/SK和SecurityToken）两种。 其中，临时安全凭证（临时AK/SK和SecurityToken）具有时效性。 初始化配置信息时，配置项的名称为“
指定配置项的认证模式 KooCLI的配置项的认证模式取值为AKSK、ecsAgency，推荐使用AKSK。当使用的配置项同时配置了多种认证模式相关的参数，用户可使用“--cli-mode”选项来指定配置项的认证模式： hcloud CCE ListNodes --cluster_
使用“--cli-query”指定的JMESPath表达式不同，输出的结果中各参数的排列顺序可能不同。部分表达式的输出结果不会带有输出数据的属性名（即参数的key值），故用户需对输出数据的顺序有所把握，以便于数据处理。不同类型的JMESPath表达式，输出结果的顺序如下表所示： 表1 不同JMESPath表达式的数据输出顺序
以JSON文件的方式传递API参数 KooCLI调用云服务的API时，如果API的参数过多，不便直接在命令中传入，用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数，例如KooCLI系统参数、未通过JSON文件传入的云服务API参数等，仍可在命令中传入，例如：
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
