检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过KooCLI管理和使用您的各类云服务资源,在调用云服务的API时,KooCLI优先使用命令中“--cli-profile”选项指定的配置项。 如您未在命令中指定配置项,会使用默认配置项来调用目标API。 若该配置项的内容与目标API不匹配,或缺少访问目标API时需要的某参数,会提示相关错误,例如:
Gateway之间的通信传输采用https协议,有效防止数据被篡改,保护用户数据在网络中的传输安全。加密协议为业界公认安全性较高的TLS1.2、TLS1.3。 敏感数据保护 用户使用KooCLI配置的认证凭据(如AK/SK)、自定义变量支持加密方式存储。 KooCLI的加密密钥在首次
指定用户所属账号ID KooCLI以AKSK模式调用全局服务的API时,需添加账号ID(即cli-domain-id)。KooCLI会在调用全局服务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud
使用? 通过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也可完成自动补全功能。
int 轮询的超时时间(秒),min=1,max=600,默认值180 - interval optional int 轮询的间隔时间(秒),min=2,max=10,默认值5 需要注意的是,因为使用“--cli-waiter”可能会导致调用接口幂等性的问题,有重复调用的风险,请您谨慎使用。建议查询类接口使用此参数。
指定配置项 KooCLI支持多配置项,用户可将常用的AK/SK,区域等信息保存到配置项中,使用时通过“--cli-profile”指定目标配置项的名称即可。如下: hcloud EVS ListSnapshots --cli-profile=test 父主题: 选项说明
API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explorer上CDN服务的创建加速域名API。在API
[CLI_ERROR]:一般是因KooCLI处理命令过程中本身的异常导致的错误,请联系KooCLI的oncall协助处理; [USE_ERROR]:一般是因命令中参数不正确造成的错误,请根据错误提示做相应修改; [OPENAPI_ERROR]:一般是调用云服务API时发生的错误,请联系相关云服务oncall协助处理;
SSO登录 KooCLI的SSO登录命令通过完成SSO登录,将用户的认证信息存储在配置文件中,避免执行操作时频繁输入这些固定信息。可通过如下命令进行SSO登录: hcloud configure sso 输入以上命令并回车后,会逐步提示您输入SSO profile name(此S
查询当前版本 查询KooCLI当前版本的命令为: hcloud version hcloud version 当前KooCLI版本:3.2.8 父主题: 常用命令
Access Key”的值需要二次确认。为保障您的账号安全,对您输入的“Secret Access Key”进行了匿名化处理。在您输入过程中不会显示输入的字符,在输入结束回车至下一行时,会以“*”回显您的输入内容。在配置完成后,KooCLI会在本地加密保存配置项中的认证相关的敏感信息。 如
无配置方式ecsAgency 在用户已成功建立向弹性云(ECS)服务器的委托的前提下,在ECS服务器中使用KooCLI时,可以在命令中指定“--cli-mode=ecsAgency”,KooCLI将基于ECS委托,自动获取临时的AK/SK和SecurityToken用于认证。 此认证方式要
无配置方式使用概述 KooCLI既可以使用配置项调用云服务API,也提供了无配置的操作方式,无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息,而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项,方便快捷地使用KooCLI。用户可以通过如下认证方式直接调用云服务API:
元数据管理 清理元数据缓存 KooCLI会缓存API调用过程中获取并保存在用户本地的元数据缓存文件,放置在如下目录下: 在线模式: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\metaRepo\ Linux系统: /home/{当前用户名}/
日志管理 KooCLI提供日志记录和管理功能,会缓存API调用过程中产生的日志信息,日志文件保存目录如下: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\log\ Linux系统: /home/{当前用户名}/.hcloud/log/ Mac系统:
风险防范 我们强烈建议您: 在.hcloud目录及其子目录和文件上配置适当的文件系统权限,仅限授权用户访问。 在使用敏感变量时对变量值进行加密,以防止敏感信息泄露。 尽可能使用临时认证凭据以降低认证凭据泄露时带来的风险。 父主题: 安全