检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Explorer上开放的各云服务API,除了支持在线调试,还能生成KooCLI命令示例(以下简称CLI示例)。您在API Explorer界面上填写API参数,在其对应的“CLI示例”中可直接拷贝使用。 下图为API Explorer上CDN服务的创建加速域名API。在API Explore
Windows 10 和 Windows 8 搜索并选择“查看高级系统设置”,然后单击“环境变量”; Windows 7 右键单击桌面上的“计算机”图标,从菜单中选择“属性”。单击“高级系统设置”链接,然后单击“环境变量”。 进入环境变量图形界面,在“用户变量”列表中,选中变量名为“Path”的环境变量,单击“编辑”。
务的API的过程中,根据用户认证信息自动获取账号ID,用户也可在命令中添加“--cli-domain-id”选项,如下: hcloud CDN ListDomains --cli-region="cn-north-1" --cli-domain-id="08e09a6e*****
Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 约束和限制 每个用户最多可以创建两个有效的访问密钥,其一旦生成永久有效。 查找已下载的访问密钥 若您已生成且下载过访问密钥(AK和SK),可在本地查找已下载的AK/SK文件,文件名一般为:credentials.csv。
--name="test-001" --description="test create configuration" --dryrun skeleton 选项 生成JSON格式API入参骨架,便于使用--cli-jsonInput的方式传入API参数 hcloud RDS CreateConfiguration
生成JSON格式API入参骨架 skeleton选项用于生成JSON格式API入参骨架。在命令中添加“--skeleton”选项,则在当前目录生成该API的JSON格式的入参文件,用户可填写文件中的参数值,以“--cli-jsonInput=${JSON文件名}”传入参数,调用API:
null,则该值将从收集的结果集中省略。 您可以使用管道表达式(稍后讨论)停止投影。 列表投影仅对json数组有效。如果左侧 (LHS) 无法创建初始值的json数组,KooCLI会提示错误告警信息并输出原json结果。 注意 people[*].first 的结果只包含三个元素
用户使用KooCLI配置的认证凭据(如AK/SK)、自定义变量支持加密方式存储。 KooCLI的加密密钥在首次使用本工具时动态生成,以确保不同KooCLI客户端加密的密文无法互相解开,即只能解密自己加密的数据。 同时,当用户通过命令查询配置的敏感数据时,数据会以脱敏方式打印在屏幕上,以防止敏感信息泄露。
cli-retry-count选项用于指定请求连接重试次数。即:在请求超时(因网络连接问题导致请求失败)的情况下会自动重试。“--cli-retry-count”的默认取值为0次,参数取值范围为0~5次: 若因网络连接问题导致请求失败,KooCLI会提示如下信息: hcloud RDS ListInstances
使用cli-jsonInput的场景有哪些? 云服务的API参数名称中带有“.”,KooCLI可能无法正确解析该参数,此时需通过cli-jsonInput传入该API的参数; 云服务的API在不同位置中有同名的参数时,KooCLI无法正确解析该API的参数,此时需通过cli-jsonInput传入该API的参数;
[-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx] sign 生成对象的下载链接 生成指定桶内对象的下载链接,或按对象名前缀批量生成桶内对象的下载链接。 生成单个对象的下载链接: hcloud obs sign obs://bucket/key [-e=300]
云服务API的响应体为空时,如何判断命令是否执行成功? 问题背景 使用KooCLI调用部分云服务的API时,API的返回结果为空,CLI不会打印相应返回体,用户无法确认是否调用成功。 解决步骤 在原命令中添加“--debug”参数,可打印命令调用过程中的调试信息。其中包含一行内容为“API response
cli-skip-secure-verify选项用于指定是否跳过https请求证书验证(不建议)。当用户已配置HTTP代理,KooCLI调用云服务的API时,可能会因证书校验失败,导致请求报错x509。用户可在命令中添加“--cli-skip-secure-verify=true”后执行原命令,在执行时会向用户交互以确认是否跳过https请求证书验证:
配置HTTP代理 用户在使用KooCLI管理和使用云服务的资源时,可能会因为用户所在公司的内网访问限制,导致调用云服务API失败。此时,用户可使用HTTP代理访问。使用HTTP代理需要配置环境变量http_proxy和https_proxy。 配置http_proxy环境变量 请
此校验过程可能需要远程获取该云服务和API的详情信息;在参数校验完成后,亦需要远程调用您的目标API。如在调用过程中因网络连接问题导致请求失败,会提示相关错误,例如: [NETWORK_ERROR]连接超时,请检查网络连通性 [USE_ERROR]调用API超时,请先检查配置项或命令中的readTimeout的值
cli-security-token 临时安全凭证。在使用临时AK/SK认证身份时,需同时使用此参数。注意过期后需重新配置,否则调用云服务API时无法完成认证。 cli-local-dea 本地加密保存的认证信息及custom参数的加密算法。取值范围: intl(默认值,表示使用国际算法)
有参数的详情信息,其中包括每个参数的类型、在request中的位置等信息。若您本地缓存的元数据文件被修改,可能会使KooCLI在运行过程中无法根据缓存文件正确解析到该API的参数详情,导致校验时提示如下错误: [CLI_ERROR]参数*的位置不正确:* [USE_ERROR]不支持的参数类型:key=*
数同名的参数,则若该参数出现在命令中,KooCLI将无法确认该参数作何种用途。故在解析该命令的过程中,会通过交互向信息向用户确认该参数的实际用途,避免解析错误。例如: 目标API中存在与KooCLI系统参数%s同名的参数,无法识别命令中%s的位置.请确认该参数为:KooCLI系统
选项说明 选项概述 打印帮助信息 打印命令调用过程中的调试信息 生成JSON格式API入参骨架 检查命令正确性 指定区域 以无配置方式AKSK调用云服务API 指定用户所属账号ID 指定配置项 指定配置项的认证模式 指定结果的输出格式 以JSON文件的方式传递API参数 指定请求超时时间
输出调用结果。 在同一命令中,“--cli-json-filter”不可以与“--cli-output-rows”,“--cli-output-cols”,“--cli-output-num”同时使用,会因无法判断输出格式而导致错误。 使用cli-json-filter定义JMESPath表达式时可参考: