检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 KooCLI只提供了一种通过CLI调用云服务API的方法。在使用KooCLI之前,您需要熟悉该API。KooC
命令中直接使用 cli-jsonInput 通过JSON文件方式传入API参数 命令中直接使用 cli-output 响应数据的输出格式[json|table|tsv] 命令中直接使用 cli-query 筛选响应数据的JMESPath路径 命令中直接使用 cli-output-num
--cli-retry-count=3 需要注意的是,因为使用“--cli-retry-count”设置重试次数可能会导致调用接口幂等性的问题,有重复调用的风险。对于创建类的接口,请您谨慎使用。 修改指定配置项的跳过https请求证书验证选项的值 hcloud configure set --cli-profile=test
cli-output,cli-query,cli-output-num cli-output 响应数据的输出格式,取值可以为如下其一: json table tsv cli-query 筛选响应数据的JMESPath路径 cli-output-num table输出时,是否打印行号。取值为:true或者false
无配置方式使用KooCLI时,需要注意如下事项: 无配置方式AKSK 访问密钥(永久AK/SK)方式 使用永久AK/SK通过KooCLI调用云服务API时,必须同时在命令中传入Access Key ID(cli-access-key),Secret Access Key(cli-secret-key)用于鉴权,缺一不可。
轮询的间隔时间(秒),min=2,max=10,默认值5 需要注意的是,因为使用“--cli-waiter”可能会导致调用接口幂等性的问题,有重复调用的风险,请您谨慎使用。建议查询类接口使用此参数。 父主题: 选项说明
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
打印帮助信息 KooCLI支持查看命令的帮助信息,例如查看“RDS”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
配置KooCLI环境。 环境配置请参考快速初始化配置。 获取云服务API调用命令。 获取云服务API调用命令有两种方式: (推荐)API Explorer上获取 云服务的API可在API Explorer上查看。您可以在API Explorer上先填写好各参数的值,即可从“CLI示例”页签中直接获取命令。
参数值中可使用“[n]”或“[m:n]”指定其中要打印的数组元素的索引位。指定“[n]”时会打印索引为n的值;指定“[m:n]”时会打印原数据m ~(n-1)索引位置的值。例如执行命令“hcloud configure list --cli-output-rows=profiles[0:2]
检查命令正确性 dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项,执行校验后打印请求报文,跳过实际运行,不调用目标API: hcloud RDS CreateConfiguration --cli-region="cn-north-4" --project_
日志进行访问权限控制以达到审计日志不可篡改的目的。此外, 同使用SDK一样,KooCLI将用户命令解析成https请求发送到API Gateway后,API Gateway记录的相关信息也可用作审计目的。 详情请见日志管理。 父主题: 安全
KooCLI既可以使用配置项调用云服务API,也提供了无配置的操作方式,无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息,而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项,方便快捷地使用KooCLI。用户可以通过如下认证方式直接调用云服务API: 无配置方式AKSK
云服务相关 提示不支持的服务时如何处理?
如何使用cli-jsonInput?注意事项有哪些? 使用cli-jsonInput的场景有哪些? 提示不支持的参数位置/类型时如何处理? 云服务API的body位置参数值如何置空?
其他 无配置方式使用KooCLI需要注意什么? 命令中服务名、operation、参数的value值是否需要使用双引号引起? 在线/离线模式分别适用什么场景? 如何卸载KooCLI?
交互式/自动补全相关 使用交互式/自动补全需要注意什么?
输出格式相关 KooCLI支持的输出格式有哪些? 如何定义JMESPath表达式 KooCLI与输出相关的系统参数有哪些,推荐使用哪些? 新输出参数cli-output,cli-query,cli-output-num在使用时的注意事项有哪些? 旧输出参数cli-output-r
步骤二:快速安装 概述 在Windows系统上安装KooCLI 在Linux系统上安装KooCLI 在MacOS系统上安装KooCLI 在Docker中配置和使用KooCLI
获取账号ID、项目ID 在调用云服务API的时候,大多数场景需要填入项目ID。项目ID获取步骤如下: 注册并登录管理控制台。 单击右上角用户名,在下拉列表中单击“我的凭证”,查看“账号ID(cli-domain-id)”、“项目ID(cli-project-id)”,如下图。 项