检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在API Explorer上获取CLI示例 API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explo
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API: hcloud
以JSON文件的方式传递API参数 KooCLI调用云服务的API时,如果API的参数过多,不便直接在命令中传入,用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数,例如KooCLI系统参数、未通过JSON文件传入的云服务API参数等,仍可在命令中传入,例如:
选项说明 选项概述 打印帮助信息 打印命令调用过程中的调试信息 生成JSON格式API入参骨架 检查命令正确性 指定区域 以无配置方式AKSK调用云服务API 指定用户所属账号ID 指定配置项 指定配置项的认证模式 指定结果的输出格式 以JSON文件的方式传递API参数 指定请求超时时间
如何指定云服务的API和版本号? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。若您当前调用的云服务是多版本服务,即意味着该服务中的部分或全部API有多个版本。因同一API不同版本的参数、使用场景等可能存在差异,故须获取多版本服务API的版本信息。 云服务API的版本查询与指定
云服务API相关 提示不支持的operation时如何处理? 如何指定云服务的API和版本号? 云服务API的响应体为空时,如何判断命令是否执行成功?
时AK/SK认证身份时,需同时使用此参数。 可用于以无配置方式AKSK调用云服务API。 以无配置方式AKSK调用云服务API: 使用访问密钥(永久AK/SK): hcloud RDS ListApiVersion --cli-region="cn-north-4" --cli-access-key=********
以无配置方式AKSK调用云服务API KooCLI支持在命令中添加“--cli-access-key”,“--cli-secret-key”和“--cli-security-token”选项,以无配置方式AKSK调用云服务API。 当命令中仅使用“--cli-access-key
S”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
指定至对象层级,KooCLI会以该对象各属性名的字典顺序,输出其对应的值。在此示例中指定至对象"items[0]",该对象中各属性按字典顺序排序后为:apiVersion,kind,metadata,spec,status。因此输出结果如下: hcloud CCE ListClusters -
”指定目标配置项的名称即可。如下: hcloud EVS ListSnapshots --cli-profile=test 父主题: 选项说明
检查命令正确性 dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项,执行校验后打印请求报文,跳过实际运行,不调用目标API: hcloud RDS CreateConfiguration --cli-region="cn-north-4" --project_
7 [debug info] 2022/06/21 19:59:26 API response status code is 200. [debug info] 2022/06/21 19:59:26 API response X-Request-Id is f9fd68****
"total_count": 0 } 需要注意的是,因为使用“--cli-retry-count”设置重试次数可能会导致调用接口幂等性的问题,有重复调用的风险。对于创建类的接口,请您谨慎使用。 父主题: 选项说明
"396ldb************************************************4a5f88ccb7" } } 父主题: 选项说明
min=2,max=10,默认值5 需要注意的是,因为使用“--cli-waiter”可能会导致调用接口幂等性的问题,有重复调用的风险,请您谨慎使用。建议查询类接口使用此参数。 父主题: 选项说明
命令中可同时使用“--cli-connect-timeout”和“--cli-read-timeout”选项,也可只使用其一。 父主题: 选项说明
"70a5****-****-****-****-****441e862b" } 不同区域,项目也不同,因此指定区域时,一般需要同时指定项目ID。 父主题: 选项说明
cli-skip-secure-verify选项用于指定是否跳过https请求证书验证(不建议)。当用户已配置HTTP代理,KooCLI调用云服务的API时,可能会因证书校验失败,导致请求报错x509。用户可在命令中添加“--cli-skip-secure-verify=true”后执行原命
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud