检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
选项概述 打印帮助信息 打印命令调用过程中的调试信息 生成JSON格式API入参骨架 检查命令正确性 指定区域 以无配置方式AKSK调用云服务API 指定用户所属账号ID 指定配置项 指定配置项的认证模式 指定结果的输出格式 以JSON文件的方式传递API参数 指定请求超时时间 指定请求连接重试次数
命令中直接使用 cli-output 响应数据的输出格式[json|table|tsv] 命令中直接使用 cli-query 筛选响应数据的JMESPath路径 命令中直接使用 cli-output-num table输出时,是否打印表格的行号。取值为true或false,默认为true
开源第三方软件更新 KooCLI采用可信流水线构建,有完善的开源第三方软件管理流程,在每次版本发布时确保使用的开源第三方软件都是没有高危漏洞的。 高危漏洞修复 当业界公布最新的高危漏洞软件时, KooCLI如果涉及会发布修复后的相关版本供用户下载或更新。 详情请见版本更新。 父主题:
隐私声明 详见《隐私政策声明》。 KooCLI的3.2.8及以后的版本在首次使用时,请您根据交互提示信息,选择是否同意其互联网连接及隐私政策声明。 对于不方便交互的场景,如以自动化脚本执行KooCLI命令,可通过如下命令,配置同意隐私声明: hcloud configure set
打印帮助信息 KooCLI支持查看命令的帮助信息,例如查看“RDS”服务operation为“ListCollations”的API的帮助信息: hcloud RDS ListCollations --cli-region="cn-north-1" --help 父主题: 选项说明
由于KooCLI是部署在用户本地的客户端工具,工具本身记录的日志可以作为审计目的使用,但是需要用户对日志进行访问权限控制以达到审计日志不可篡改的目的。此外, 同使用SDK一样,KooCLI将用户命令解析成https请求发送到API Gateway后,API Gateway记录的相关信息也可用作审计目的。
Gateway之间的通信传输采用https协议,有效防止数据被篡改,保护用户数据在网络中的传输安全。加密协议为业界公认安全性较高的TLS1.2、TLS1.3。 敏感数据保护 用户使用KooCLI配置的认证凭据(如AK/SK)、自定义变量支持加密方式存储。 KooCLI的加密密钥在首次
int 轮询的超时时间(秒),min=1,max=600,默认值180 - interval optional int 轮询的间隔时间(秒),min=2,max=10,默认值5 需要注意的是,因为使用“--cli-waiter”可能会导致调用接口幂等性的问题,有重复调用的风险,请您谨慎使用。建议查询类接口使用此参数。
旧输出参数cli-json-filter如何使用? 通过KooCLI调用云服务API,默认会返回json格式的调用结果。KooCLI支持使用“--cli-json-filter”对json结果执行JMESPath查询,方便提炼其中的关键信息,如下: 以默认的json格式输出原调用结果: hcloud ECS
数查看帮助信息,例如: hcloud --help 查看KooCLI的使用方法及支持的云服务列表。 hcloud <service> --help 查看指定云服务的operation列表。例如查看“ECS”服务的operation列表:hcloud ECS --help hcloud
Explorer页面中,您可以在除IE之外的任意浏览器上在线体验KooCLI,如下图所示,鼠标左键单击“CLI示例”方框中的图标按钮即可启动。 图1 在API Explorer上启动在线体验功能 启动时会自动为您分配一个Linux系统的容器(以下称之为实例)供您使用,该实例上已预装最新版的KooCLI。在线体验功能具有以下优点:
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
风险防范 我们强烈建议您: 在.hcloud目录及其子目录和文件上配置适当的文件系统权限,仅限授权用户访问。 在使用敏感变量时对变量值进行加密,以防止敏感信息泄露。 尽可能使用临时认证凭据以降低认证凭据泄露时带来的风险。 父主题: 安全
自定义请求域名 cli-endpoint用于自定义请求云服务的域名。KooCLI默认会请求对应区域的目标云服务,您也可以针对该云服务指定Endpoint: hcloud IoTDA UpdateDevice --cli-region="cn-north-4" --description="test
指定配置项 KooCLI支持多配置项,用户可将常用的AK/SK,区域等信息保存到配置项中,使用时通过“--cli-profile”指定目标配置项的名称即可。如下: hcloud EVS ListSnapshots --cli-profile=test 父主题: 选项说明
获取认证信息 获取永久AK/SK 获取账号ID、项目ID 获取区域 获取临时AK/SK和securitytoken
概述 在Windows系统上安装KooCLI 在Linux系统上安装KooCLI 在MacOS系统上安装KooCLI 在Docker中配置和使用KooCLI
API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explorer上CDN服务的创建加速域名API。在API
"instances": [], "total_count": 0 } 需要注意的是,因为使用“--cli-retry-count”设置重试次数可能会导致调用接口幂等性的问题,有重复调用的风险。对于创建类的接口,请您谨慎使用。 父主题: 选项说明
查询当前版本 查询KooCLI当前版本的命令为: hcloud version hcloud version 当前KooCLI版本:3.2.8 父主题: 常用命令