检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
输出格式相关 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)”,如下图。 项
会根据当前API的参数列表自动识别各个参数的用途: 若目标API中存在“region”同名参数,或可自定义参数名称,KooCLI会在命令执行过程中自动将“--cli-region”识别为系统参数,其值用于获取目标API的详情信息;而将“--region”识别为目标API的参数,其值将用于目标API的调用。
息。 API 已输入的云服务/系统命令经校验无误后,会继续提示该服务的API列表/该系统命令的子命令(或参数)。 所提示的系统命令列表中,左列展示该系统命令的子命令(或参数),右列展示该子命令(或参数)的描述信息。 图2 交互式中提示云服务的API列表 所提示的云服务API列表中
--cli-retry-count=3 需要注意的是,因为使用“--cli-retry-count”设置重试次数可能会导致调用接口幂等性的问题,有重复调用的风险。对于创建类的接口,请您谨慎使用。 修改指定配置项的跳过https请求证书验证选项的值 hcloud configure set --cli-profile=test
旧输出参数cli-output-rows,cli-output-cols,cli-output-num如何使用? 通过KooCLI调用云服务API,默认会返回json格式的调用结果。KooCLI支持使用“--cli-output-rows”,“--cli-output-cols”,“
eName}”传入JSON文件,向KooCLI传递云服务API参数。KooCLI会在运行时解析并使用该JSON文件中的参数调用目标API。 使用方式 cli-jsonInput的使用方式请参考:以JSON文件的方式传递API参数。 注意事项 “--cli-jsonInput”选项
旧输出参数cli-json-filter如何使用? 通过KooCLI调用云服务API,默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询,方便提炼其中的关键信息,如下: 以默认的json格式输出原调用结果:
概述 如果您需要同时在多个区域或多个项目下管理资源,或者同时使用多个账号,可以通过增加配置项的方式,存储多个不同场景的固定信息。已配置多个配置项的情况下,您可在命令中以“--cli-profile”指定要操作或使用的配置项的名称。 KooCLI配置项中可修改的参数如下表所示。 表1
提示不支持的服务时如何处理? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验。如果您命令中云服务的名称输入有误,或调用的云服务未在KooCLI上线,会提示相关错误: [USE_ERROR]不支持的服务名称:* 解决步骤 如遇如上情形,您可先通过执行“hcloud
无法识别命令中%s的位置.请确认该参数为:KooCLI系统参数(a);目标API参数(b);兼为两者(c): 目标API中可自定义与KooCLI系统参数%s同名的参数,无法识别命令中%s的位置.请确认该参数为:KooCLI系统参数(a);目标API参数(b);兼为两者(c): 因此,当您构建KooCL
在线/离线模式分别适用什么场景? 查看/切换当前模式 KooCLI支持在线/离线模式。默认为在线模式。添加配置项之后,您可以执行“hcloud configure list --cli-query=offline”命令查看当前是否已使用离线模式。 执行命令“hcloud configure
元数据管理 清理元数据缓存 KooCLI会缓存API调用过程中获取并保存在用户本地的元数据缓存文件,放置在如下目录下: 在线模式: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\metaRepo\ Linux系统: /home/{当前用户名}/
日志管理 KooCLI提供日志记录和管理功能,会缓存API调用过程中产生的日志信息,日志文件保存目录如下: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\log\ Linux系统: /home/{当前用户名}/.hcloud/log/ Mac系统:
轮询的间隔时间(秒),min=2,max=10,默认值5 需要注意的是,因为使用“--cli-waiter”可能会导致调用接口幂等性的问题,有重复调用的风险,请您谨慎使用。建议查询类接口使用此参数。 父主题: 选项说明
--help hcloud <service> <operation> --help 查看指定云服务API的详情信息。例如查看“ECS”服务中,operation为“ShowServer”的API详情:hcloud ECS ShowServer --help 父主题: 常用命令
无配置方式使用KooCLI时,需要注意如下事项: 无配置方式AKSK 访问密钥(永久AK/SK)方式 使用永久AK/SK通过KooCLI调用云服务API时,必须同时在命令中传入Access Key ID(cli-access-key),Secret Access Key(cli-secret-key)用于鉴权,缺一不可。
配置HTTP代理 用户在使用KooCLI管理和使用云服务的资源时,可能会因为用户所在公司的内网访问限制,导致调用云服务API失败。此时,用户可使用HTTP代理访问。使用HTTP代理需要配置环境变量http_proxy和https_proxy。 配置http_proxy环境变量 请
图1 入门流程 注册华为帐号,创建IAM用户并授权,获取访问密钥等,请参见步骤一:准备工作。 使用KooCLI调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源前,需要先下载对应操作系统的KooCLI,请参见步骤二:快速安装。 使用KooCLI时,