检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
风险防范 我们强烈建议您: 在.hcloud目录及其子目录和文件上配置适当的文件系统权限,仅限授权用户访问。 在使用敏感变量时对变量值进行加密,以防止敏感信息泄露。 尽可能使用临时认证凭据以降低认证凭据泄露时带来的风险。 父主题: 安全
选项概述 KooCLI选项是指可以直接在调用API的命令中添加的系统参数,KooCLI支持的选项及其功能如下表所示。其中除“help”,“debug”,“dryrun”,“cli-output”,“cli-query”,“cli-output-num”,“cli-jsonInpu
传入,用户可通过“--cli-jsonInput”将云服务API的部分或全部参数以JSON文件的形式输入。剩余的其他参数,例如KooCLI系统参数、未通过JSON文件传入的云服务API参数等,仍可在命令中传入,例如: hcloud ECS CreateServers --cli-region="cn-north-4"
ws 64位、Linux AMD 64位、Linux ARM 64位、macOS AMD 64位、macOS ARM 64位,请根据您本地系统下载对应的版本。 配置KooCLI环境。 环境配置请参考快速初始化配置。 获取云服务API调用命令。 获取云服务API调用命令有两种方式:
某参数与系统参数重名的情况。 解决方案 若提示的错误信息为上述第一种,则命令中可能存在重复的非系统参数,请您检查是否误输。此错误也可能与系统解析处理命令内容有关,若参数值有特殊符号,请使用双引号引起,避免解析错误。 若提示的错误信息为上述第二种,说明命令中存在重复的旧系统参数,您可使用“hcloud
run”时仅支持KooCLI相关命令。 创建临时容器,向容器共享宿主机文件(以Linux系统的宿主机为例),并执行命令: 通过宿主机系统目录和容器目录的挂载,将宿主机文件共享到容器: 示例1:通过将宿主机系统的/root/.hcloud/目录挂载到容器的/root/.hcloud/目录下,将宿主机配置文件共享到容器:
标左键单击“CLI示例”方框中的图标按钮即可启动。 图1 在API Explorer上启动在线体验功能 启动时会自动为您分配一个Linux系统的容器(以下称之为实例)供您使用,该实例上已预装最新版的KooCLI。在线体验功能具有以下优点: 实例启动后默认将当前CLI示例内容复制到实例窗口并执行。
元数据缓存文件的存放位置 在线模式: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\metaRepo\ Linux系统: /home/{当前用户名}/.hcloud/metaRepo/ Mac系统: /Users/{当前用户名}/.hcloud/metaRepo/
初次进入交互模式后,会自动提示云服务及系统命令列表。 图1 交互式中提示云服务和系统命令列表 所提示的云服务列表中,左列展示云服务短名/系统命令,右列展示该云服务的服务名称/该系统命令的描述信息。 API 已输入的云服务/系统命令经校验无误后,会继续提示该服务的API列表/该系统命令的子命令(或参数)。
步骤二:快速安装 概述 在Windows系统上安装KooCLI 在Linux系统上安装KooCLI 在MacOS系统上安装KooCLI 在Docker中配置和使用KooCLI
AMD 64位、macOS ARM 64位,请根据您本地系统下载对应的版本。 Windows系统 在Windows系统上安装KooCLI Linux系统 在Linux系统上安装KooCLI MacOS系统 在MacOS系统上安装KooCLI Docker容器 在Docker中配置和使用KooCLI
参数可分为API参数和KooCLI系统参数。API参数是指云服务的API中定义的参数;系统参数是指KooCLI的内置参数,具有其固定的使用方式和特定含义。请查看系统参数列表。 选项 KooCLI选项是指可以直接在调用API的命令中添加的KooCLI系统参数,并非所有的系统参数都可作为选项使用。请查看选项列表。
参数相关 KooCLI系统参数包括哪些? 提示不正确的参数时如何处理? 为什么会有新旧KooCLI系统参数,如cli-region与region,推荐使用哪个? 提示重复的参数时如何处理? 如何使用cli-jsonInput?注意事项有哪些? 使用cli-jsonInput的场景有哪些?
注意事项 “--cli-jsonInput”选项传入的JSON文件中目前只支持写入云服务的API参数,不支持写入系统参数。若目标API中存在与新系统参数或旧系统参数重名的参数,被写入jsonInput文件中的默认将被识别为该API的参数; “--cli-jsonInput”选
使用“--cli-query”时,其值建议使用双引号引起。避免系统处理命令时的解析错误。 若要使用“--cli-output-num”指定是否打印行号,此时必须指定“--cli-output”的取值为table。 在同一命令中,已使用了“--cli-output”的情况下,若同时指定旧系统参数如“--cli-out
时,设置其中的系统参数;当“--cli-custom=true”时,设置其中的custom(即用户自定义)参数。 设置配置项中的系统参数时,若该配置项不存在则新增配置项,否则修改该配置项。 不支持向不存在的配置项中设置custom参数;不支持在同一命令中同时设置系统参数和custom参数。
单一可执行文件,绿色免安装,下载解压后即可使用。 多操作系统支持,包括Linux、Windows、Mac。 扩展性强,您可基于此工具对云服务API进行封装,扩展出您想要的功能,实现脚本化管理云服务资源。 下载KooCLI,请参考《快速入门》。 您也可以在线体验KooCLI。 在Windows系统使用KooCLI时,请勿双击执行hcloud
新增或修改配置项 概述 设置配置项中的系统参数 设置配置项中的custom参数 父主题: 配置信息管理
查询指定配置项 查询指定配置项中的系统参数 查询指定配置项中的custom参数 父主题: 配置信息管理
查询配置项列表 查询配置项列表中的系统参数 查询配置项列表中的custom参数 父主题: 配置信息管理