检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
交互式中提示云服务和系统命令列表 所提示的云服务列表中,左列展示云服务短名/系统命令,右列展示该云服务的服务名称/该系统命令的描述信息。 API 已输入的云服务/系统命令经校验无误后,会继续提示该服务的API列表/该系统命令的子命令(或参数)。 所提示的系统命令列表中,左列展示该系统命令的子命令(或参数)
删除指定配置项及其custom参数 使用“--cli-profile”指定要删除的配置项的名称。删除指定配置项的命令为: hcloud configure delete --cli-profile=${profileName} hcloud configure delete --cli-profile=test
数查看帮助信息,例如: hcloud --help 查看KooCLI的使用方法及支持的云服务列表。 hcloud <service> --help 查看指定云服务的operation列表。例如查看“ECS”服务的operation列表:hcloud ECS --help hcloud
} } 生成的JSON文件分为上下两部分,上半部分为cli-jsonInput需要的API参数骨架,下半部分为各参数的描述信息及其取值规范。中间以分割线分割。用户可参考参数的描述信息,在上半部分的骨架中填写参数值。 JSON文件填写完成后,需删除分割线及下半部分的内容。对于未填写取值的参数,使用时也需要删除该参数。
本节以Windows系统为例介绍KooCLI的使用,Linux和MacOS系统的使用基本相同,可参考。 KooCLI最基础的入门操作包括:快速安装、初始化配置信息,查看与执行云服务操作命令。 图1为KooCLI大致的入门流程,本入门指导旨在帮助您对其操作有初步的认识。 图1 入门流程 注册华为
步安装时请根据您的操作系统选择相应的安装命令。执行如下命令可查看您主机的操作系统: echo $HOSTTYPE 若执行如上命令的输出值是“x86_64”,请使用AMD 64位系统的下载命令;若执行如上命令的输出值是“aarch64”,请使用ARM 64位系统的下载命令。 一键式安装
步安装。分步安装时请根据您的操作系统选择相应的安装命令。执行如下命令查看您主机的操作系统: echo $HOSTTYPE 若执行如上命令的输出值是“x86_64”,请使用AMD 64位系统的下载命令;若执行该命令输出结果为空,请使用如下命令查看您主机的操作系统: uname -a
CLI)是为发布在API Explorer上的云服务API提供的命令行管理工具。您可以通过此工具调用API Explorer中各云服务开放的API,管理和使用您的各类云服务资源。 KooCLI只提供了一种通过CLI调用云服务API的方法。在使用KooCLI之前,您需要熟悉该AP
通过KooCLI管理和使用您的各类云服务资源时,会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数,提高响应速度,KooCLI引入了缓存机制,在运行过程中将云服务及其API的相关信息保存在本地缓存文件中,该文件称为元数据缓存文件。在元数据缓存文件过期前,会使用该文件中的信息对命令中的参数进行校验和组装。
通过KooCLI管理和使用您的各类云服务资源,在调用云服务的API时,KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项,会使用默认配置项来调用目标API。 若该配置项的内容与目标API不匹配,或缺少访问目标API时需要的某参数,会提示相关错误,例如:
本节以Windows系统为例介绍KooCLI的使用,Linux和Mac系统的使用基本相同,可参考。 完成初始化配置后,即可查询KooCLI支持的云服务列表,并执行相关命令。下文以弹性云服务器(ECS)的查询云服务器详情的API为例,说明如何查找与执行命令。 查询云服务的operation列表 hcloud
credential.csv文件内容 创建新的访问密钥 如您尚未生成过或未能找到本地的AK/SK文件,可创建新的访问密钥: 登录控制台。 在顶部导航栏单击用户名,并选择“我的凭证”。 进入“我的凭证”页面,单击“管理访问密钥”页签下方的“新增访问密钥”。 在弹出的“新增访问密钥”对话框中,输入登录密码和对应验证码。
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
自定义请求域名 cli-endpoint用于自定义请求云服务的域名。KooCLI默认会请求对应区域的目标云服务,您也可以针对该云服务指定Endpoint: hcloud IoTDA UpdateDevice --cli-region="cn-north-4" --description="test
由于KooCLI是部署在用户本地的客户端工具,工具本身记录的日志可以作为审计目的使用,但是需要用户对日志进行访问权限控制以达到审计日志不可篡改的目的。此外, 同使用SDK一样,KooCLI将用户命令解析成https请求发送到API Gateway后,API Gateway记录的相关信息也可用作审计目的。
使用? 通过KooCLI调用云服务API,默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询,方便提炼其中的关键信息,如下: 以默认的json格式输出原调用结果: hcloud ECS NovaListServers
} 以table输出调用结果时,“--cli-output-rows”指定json结构体的层级,即表格的数据来源;“--cli-output-cols”指定表格的列名,需要与json结构体中的字段相对应;“--cli-output-num”指定是否打印表格行号,默认值为true,如下图所示:
Explorer页面中,您可以在除IE之外的任意浏览器上在线体验KooCLI,如下图所示,鼠标左键单击“CLI示例”方框中的图标按钮即可启动。 图1 在API Explorer上启动在线体验功能 启动时会自动为您分配一个Linux系统的容器(以下称之为实例)供您使用,该实例上已预装最新版的KooCLI。在线体验功能具有以下优点:
PI中存在与新系统参数或旧系统参数重名的参数,被写入jsonInput文件中的默认将被识别为该API的参数; “--cli-jsonInput”选项传入的JSON文件中,KooCLI会根据JSON最外层的Key获取并解析其的参数值,目前支持的Key包括:path、query、bo
自动补全提示参数时,若提示的参数名中有“[N]”,其含义为索引位,请使用数字代替该字符;若提示的参数名中有“{*}”,其含义为自定义参数名称,请使用任意不含“.”的字符串代替该字符; 若同一机器同一用户的多个目录下有KooCLI,且其中某一目录下的工具开启了自动补全,则该用户其他目录下的KooCLI也可完成自动补全功能。