检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
本节以Windows系统为例介绍KooCLI的使用,Linux和MacOS系统的使用基本相同,可参考。 KooCLI最基础的入门操作包括:快速安装、初始化配置信息,查看与执行云服务操作命令。 图1为KooCLI大致的入门流程,本入门指导旨在帮助您对其操作有初步的认识。 图1 入门流程 注册华为
打印帮助信息 KooCLI支持查看命令的帮助信息,例如查看“RDS”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
通过KooCLI管理和使用您的各类云服务资源时,会远程获取您命令中目标云服务及其API的详情信息。为减少远程调用次数,提高响应速度,KooCLI引入了缓存机制,在运行过程中将云服务及其API的相关信息保存在本地缓存文件中,该文件称为元数据缓存文件。在元数据缓存文件过期前,会使用该文件中的信息对命令中的参数进行校验和组装。
} } 生成的JSON文件分为上下两部分,上半部分为cli-jsonInput需要的API参数骨架,下半部分为各参数的描述信息及其取值规范。中间以分割线分割。用户可参考参数的描述信息,在上半部分的骨架中填写参数值。 JSON文件填写完成后,需删除分割线及下半部分的内容。对于未填写取值的参数,使用时也需要删除该参数。
在“重启”单击左键,当前实例将会重启。重启实例将会终止所有会话并创建一个新的会话,任何正在进行中的进程都会被终止,非持久化存储的数据将被清空。 设置 在“设置”单击左键,可设置当前实例的字体大小和样式。 上传下载 可以将文件上传到工作空间中的用户目录下。反之,也可以把工作空间的文件下载到本地。 在“上传/下载”中单
通过KooCLI管理和使用您的各类云服务资源,在调用云服务的API时,KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项,会使用默认配置项来调用目标API。 若该配置项的内容与目标API不匹配,或缺少访问目标API时需要的某参数,会提示相关错误,例如:
Gateway之间的通信传输采用https协议,有效防止数据被篡改,保护用户数据在网络中的传输安全。加密协议为业界公认安全性较高的TLS1.2、TLS1.3。 敏感数据保护 用户使用KooCLI配置的认证凭据(如AK/SK)、自定义变量支持加密方式存储。 KooCLI的加密密钥在首次
删除指定配置项及其custom参数 使用“--cli-profile”指定要删除的配置项的名称。删除指定配置项的命令为: hcloud configure delete --cli-profile=${profileName} hcloud configure delete --cli-profile=test
开源第三方软件更新 KooCLI采用可信流水线构建,有完善的开源第三方软件管理流程,在每次版本发布时确保使用的开源第三方软件都是没有高危漏洞的。 高危漏洞修复 当业界公布最新的高危漏洞软件时, KooCLI如果涉及会发布修复后的相关版本供用户下载或更新。 详情请见版本更新。 父主题:
on”。其中,未添加“cli-”前缀的称为旧系统参数;添加了“cli-”前缀的称为新系统参数。之所以支持新系统参数,是因为在KooCLI上开放的云服务中,存在部分API的某参数与旧系统参数重名的情况。该场景可能会使命令中两个同名的参数用于不同的用途,即:其一作为目标API参数,另
} 以table输出调用结果时,“--cli-output-rows”指定json结构体的层级,即表格的数据来源;“--cli-output-cols”指定表格的列名,需要与json结构体中的字段相对应;“--cli-output-num”指定是否打印表格行号,默认值为true,如下图所示:
PI中存在与新系统参数或旧系统参数重名的参数,被写入jsonInput文件中的默认将被识别为该API的参数; “--cli-jsonInput”选项传入的JSON文件中,KooCLI会根据JSON最外层的Key获取并解析其的参数值,目前支持的Key包括:path、query、bo
自动补全提示参数时,若提示的参数名中有“[N]”,其含义为索引位,请使用数字代替该字符;若提示的参数名中有“{*}”,其含义为自定义参数名称,请使用任意不含“.”的字符串代替该字符; 若同一机器同一用户的多个目录下有KooCLI,且其中某一目录下的工具开启了自动补全,则该用户其他目录下的KooCLI也可完成自动补全功能。
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
理清业务逻辑,完成复杂场景下的操作。用户可根据实际需要下载相应的模板,修改后执行即可。 发布区域:全部 模板管理 常用选项 KooCLI选项是指可以直接在调用API的命令中添加的KooCLI系统参数。 发布区域:全部 打印帮助信息 打印命令调用过程中的调试信息 检查命令正确性 指定输出格式
使用? 通过KooCLI调用云服务API,默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询,方便提炼其中的关键信息,如下: 以默认的json格式输出原调用结果: hcloud ECS NovaListServers
Explorer页面中,您可以在除IE之外的任意浏览器上在线体验KooCLI,如下图所示,鼠标左键单击“CLI示例”方框中的图标按钮即可启动。 图1 在API Explorer上启动在线体验功能 启动时会自动为您分配一个Linux系统的容器(以下称之为实例)供您使用,该实例上已预装最新版的KooCLI。在线体验功能具有以下优点:
指定配置项 KooCLI支持多配置项,用户可将常用的AK/SK,区域等信息保存到配置项中,使用时通过“--cli-profile”指定目标配置项的名称即可。如下: hcloud EVS ListSnapshots --cli-profile=test 父主题: 选项说明
隐私声明 详见《隐私政策声明》。 KooCLI的3.2.8及以后的版本在首次使用时,请您根据交互提示信息,选择是否同意其互联网连接及隐私政策声明。 对于不方便交互的场景,如以自动化脚本执行KooCLI命令,可通过如下命令,配置同意隐私声明: hcloud configure set
自定义请求域名 cli-endpoint用于自定义请求云服务的域名。KooCLI默认会请求对应区域的目标云服务,您也可以针对该云服务指定Endpoint: hcloud IoTDA UpdateDevice --cli-region="cn-north-4" --description="test