检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
由于KooCLI是部署在用户本地的客户端工具,工具本身记录的日志可以作为审计目的使用,但是需要用户对日志进行访问权限控制以达到审计日志不可篡改的目的。此外, 同使用SDK一样,KooCLI将用户命令解析成https请求发送到API Gateway后,API Gateway记录的相关信息也可用作审计目的。
参数可分为API参数和KooCLI系统参数。API参数是指云服务的API中定义的参数;系统参数是指KooCLI的内置参数,具有其固定的使用方式和特定含义。请查看系统参数列表。 选项 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。在线体验功能具有以下优点:
credential.csv文件内容 创建新的访问密钥 如您尚未生成过或未能找到本地的AK/SK文件,可创建新的访问密钥: 登录控制台。 在顶部导航栏单击用户名,并选择“我的凭证”。 进入“我的凭证”页面,单击“管理访问密钥”页签下方的“新增访问密钥”。 在弹出的“新增访问密钥”对话框中,输入登录密码和对应验证码。
用户通过KooCLI对自己的资源进行调试及操作时和用户通过SDK操作华为云资源的访问权限是一致的,用户对华为云上某资源的访问控制权限和用户在相关服务里的权限保持一致。 对配置文件及运行日志的访问控制 KooCLI是运行在用户本地的一款客户端工具, KooCLI使用的相关配置文件及运行日
} 以table输出调用结果时,“--cli-output-rows”指定json结构体的层级,即表格的数据来源;“--cli-output-cols”指定表格的列名,需要与json结构体中的字段相对应;“--cli-output-num”指定是否打印表格行号,默认值为true,如下图所示:
自动补全提示参数时,若提示的参数名中有“[N]”,其含义为索引位,请使用数字代替该字符;若提示的参数名中有“{*}”,其含义为自定义参数名称,请使用任意不含“.”的字符串代替该字符; 若同一机器同一用户的多个目录下有KooCLI,且其中某一目录下的工具开启了自动补全,则该用户其他目录下的KooCLI也可完成自动补全功能。
隐私声明 详见《隐私政策声明》。 KooCLI的3.2.8及以后的版本在首次使用时,请您根据交互提示信息,选择是否同意其互联网连接及隐私政策声明。 对于不方便交互的场景,如以自动化脚本执行KooCLI命令,可通过如下命令,配置同意隐私声明: hcloud configure set
如何解决网络连接超时问题? 问题背景 KooCLI调用云服务API的过程中,会对您输入参数的合法性进行校验,此校验过程可能需要远程获取该云服务和API的详情信息;在参数校验完成后,亦需要远程调用您的目标API。如在调用过程中因网络连接问题导致请求失败,会提示相关错误,例如: [NETWORK_ERROR]连接超时
自定义请求域名 cli-endpoint用于自定义请求云服务的域名。KooCLI默认会请求对应区域的目标云服务,您也可以针对该云服务指定Endpoint: hcloud IoTDA UpdateDevice --cli-region="cn-north-4" --description="test
SSO登录 KooCLI的SSO登录命令通过完成SSO登录,将用户的认证信息存储在配置文件中,避免执行操作时频繁输入这些固定信息。可通过如下命令进行SSO登录: hcloud configure sso 输入以上命令并回车后,会逐步提示您输入SSO profile name(此S
[CLI_ERROR]:一般是因KooCLI处理命令过程中本身的异常导致的错误,请联系KooCLI的oncall协助处理; [USE_ERROR]:一般是因命令中参数不正确造成的错误,请根据错误提示做相应修改; [OPENAPI_ERROR]:一般是调用云服务API时发生的错误,请联系相关云服务oncall协助处理;
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 父主题: 选项说明
Access Key”的值需要二次确认。为保障您的账号安全,对您输入的“Secret Access Key”进行了匿名化处理。在您输入过程中不会显示输入的字符,在输入结束回车至下一行时,会以“*”回显您的输入内容。在配置完成后,KooCLI会在本地加密保存配置项中的认证相关的敏感信息。 如
API Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explorer上CDN服务的创建加速域名API。在API
查询当前版本 查询KooCLI当前版本的命令为: hcloud version hcloud version 当前KooCLI版本:3.2.8 父主题: 常用命令
元数据管理 清理元数据缓存 KooCLI会缓存API调用过程中获取并保存在用户本地的元数据缓存文件,放置在如下目录下: 在线模式: Windows系统: C:\Users\{您的Windows系统用户名}\.hcloud\metaRepo\ Linux系统: /home/{当前用户名}/
无配置方式使用概述 KooCLI既可以使用配置项调用云服务API,也提供了无配置的操作方式,无配置方式使用是指在使用KooCLI时不通过已有配置项传入当前用户的认证信息,而是直接在命令中传入当前用户认证相关的参数。此方式可使用户免于添加配置项,方便快捷地使用KooCLI。用户可以通过如下认证方式直接调用云服务API: