检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取认证信息 获取永久AK/SK 请参考获取永久AK/SK。 获取账号ID、项目ID 请参考获取账号ID、项目ID。 获取区域 请参考终端节点及区域说明。 获取临时AK/SK和securitytoken 请参考获取临时AK/SK和securitytoken。 父主题: 认证相关
查看帮助信息 KooCLI支持在命令中添加“--help”参数查看帮助信息,例如: hcloud --help 查看KooCLI的使用方法及支持的云服务列表。 hcloud <service> --help 查看指定云服务的operation列表。例如查看“ECS”服务的operation
查询当前版本 查询KooCLI当前版本的命令为: hcloud version hcloud version 当前KooCLI版本:3.2.8 父主题: 常用命令
交互式提示 KooCLI支持功能强大的多平台支持的交互式提示,方便命令构建,在命令中添加“--interactive”参数即可进入交互式提示。交互式中根据用户当前输入的内容,提示云服务名称,API的operation,参数及其描述信息,也提供部分参数值的补全功能。 交互式的使用方式如下
检查命令正确性 dryrun选项用于检查所传入命令的正确性。在命令中添加“--dryrun”选项,执行校验后打印请求报文,跳过实际运行,不调用目标API: hcloud RDS CreateConfiguration --cli-region="cn-north-4" --project_id
无配置方式使用KooCLI 无配置方式使用概述 无配置方式AKSK 无配置方式ecsAgency
日志文件存于何处? KooCLI会记录您使用过程中产生的日志信息。日志记录功能暂不支持关闭。 日志文件名称为“hcloud.log”,日志文件的存放位置如下: Linux系统:/home/{当前用户名}/.hcloud/log/ Windows系统:C:\Users\{当前用户名}
read-timeout I/O超时时间(秒),默认值10秒,参数最小取值为1秒 cli-read-timeout retry-count 请求连接重试次数,默认取值为0次,参数取值范围为0~5次 cli-retry-count security-token 用户获取的临时token
初始化配置 KooCLI初始化命令用于将常用的永久AK/SK和区域信息存储在配置文件中,避免执行操作时频繁输入这些固定信息。可通过如下命令初始化配置: hcloud configure init 输入以上命令并按回车后,会逐步提示您输入Access Key ID(必填)、Secret
认证方式优先级 KooCLI在命令解析过程中,依照如下优先级使用其认证方式,完成调用API时的认证流程: 无配置方式AKSK认证: 无配置方式AKSK:命令中直接输入访问密钥(永久AK/SK,即cli-access-key和cli-secret-key)或临时安全凭证(临时AK/SK
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
指定配置项的认证模式 KooCLI的配置项的认证模式取值为AKSK、ecsAgency,推荐使用AKSK。当使用的配置项同时配置了多种认证模式相关的参数,用户可使用“--cli-mode”选项来指定配置项的认证模式: hcloud CCE ListNodes --cluster_id
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API
指定结果的输出格式 命令中使用“--cli-query”传入JMESPath表达式,对结果执行JMESPath查询,方便提炼原返回结果中的关键信息;“--cli-output”指定响应数据的输出格式;“--cli-output-num”指定当使用table格式输出时,是否打印行号。
修改已初始化的配置项 KooCLI目前支持在配置项中以如下组合方式配置认证参数:访问密钥(永久AK/SK),临时安全凭证(临时AK/SK和SecurityToken)两种。 其中,临时安全凭证(临时AK/SK和SecurityToken)具有时效性。 初始化配置信息时,配置项的名称为
查询指定配置项 查询指定配置项中的系统参数 查询指定配置项中的custom参数 父主题: 配置信息管理
删除指定配置项 删除指定配置项及其custom参数 删除指定配置项中的custom参数 父主题: 配置信息管理
删除所有配置项 可执行如下命令,经交互确认后即可删除所有配置项: hcloud configure clear hcloud configure clear 是否删除所有配置信息(y/N): y 已删除所有配置信息 父主题: 配置信息管理
步骤四:查看与执行云服务操作命令 本节以Windows系统为例介绍KooCLI的使用,Linux和Mac系统的使用基本相同,可参考。 完成初始化配置后,即可查询KooCLI支持的云服务列表,并执行相关命令。下文以弹性云服务器(ECS)的查询云服务器详情的API为例,说明如何查找与执行命令
提示重复的参数时如何处理? 问题背景 KooCLI在命令执行过程中会对参数的合法性进行检查,若命令中存在重复参数,视具体场景不同,会提示不同错误,例如: [USE_ERROR]重复的参数:* [USE_ERROR]重复的参数*,如非误输,请以cli-*为key输入其中的KooCLI